From 5e96da2108045bf54f4782003d22bd3bd8a1df2a Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Tue, 25 Mar 2025 09:57:32 -0700 Subject: [PATCH] Add Alibaba Cloud inference API (#4021) (cherry picked from commit ef980f02341b23df1b68d1aea9e52f4934988da2) --- output/openapi/elasticsearch-openapi.json | 175 +- .../elasticsearch-serverless-openapi.json | 175 +- output/schema/schema-serverless.json | 90057 ++++++++-------- output/schema/schema.json | 326 + output/typescript/types.ts | 30 + specification/_doc_ids/table.csv | 6 + .../inference.put_alibabacloud.json | 35 + .../PutAlibabaCloudRequest.ts | 154 + .../PutAlibabaCloudResponse.ts | 24 + .../PutAlibabaCloudRequestExample1.yaml | 14 + .../PutAlibabaCloudRequestExample2.yaml | 14 + .../PutAlibabaCloudRequestExample3.yaml | 14 + .../PutAlibabaCloudRequestExample4.yaml | 14 + 13 files changed, 47519 insertions(+), 43519 deletions(-) create mode 100644 specification/_json_spec/inference.put_alibabacloud.json create mode 100644 specification/inference/put_alibabacloud/PutAlibabaCloudRequest.ts create mode 100644 specification/inference/put_alibabacloud/PutAlibabaCloudResponse.ts create mode 100644 specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample1.yaml create mode 100644 specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample2.yaml create mode 100644 specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample3.yaml create mode 100644 specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample4.yaml diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 5ebd55e313..556377ac49 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -17748,6 +17748,102 @@ "x-state": "Added in 9.0.0" } }, + "/_inference/{task_type}/{alibabacloud_inference_id}": { + "put": { + "tags": [ + "inference" + ], + "summary": "Create an AlibabaCloud AI Search inference endpoint", + "description": "Create an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", + "operationId": "inference-put-alibabacloud", + "parameters": [ + { + "in": "path", + "name": "task_type", + "description": "The type of the inference task that the model will perform.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/inference.put_alibabacloud:AlibabaCloudTaskType" + }, + "style": "simple" + }, + { + "in": "path", + "name": "alibabacloud_inference_id", + "description": "The unique identifier of the inference endpoint.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "chunking_settings": { + "$ref": "#/components/schemas/inference._types:InferenceChunkingSettings" + }, + "service": { + "$ref": "#/components/schemas/inference.put_alibabacloud:ServiceType" + }, + "service_settings": { + "$ref": "#/components/schemas/inference.put_alibabacloud:AlibabaCloudServiceSettings" + }, + "task_settings": { + "$ref": "#/components/schemas/inference.put_alibabacloud:AlibabaCloudTaskSettings" + } + }, + "required": [ + "service", + "service_settings" + ] + }, + "examples": { + "PutAlibabaCloudRequestExample1": { + "summary": "A completion task", + "description": "Run `PUT _inference/completion/alibabacloud_ai_search_completion` to create an inference endpoint that performs a completion task.", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"host\" : \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-qwen-turbo\",\n \"workspace\" : \"default\"\n }\n}" + }, + "PutAlibabaCloudRequestExample2": { + "summary": "A rerank task", + "description": "Run `PUT _inference/rerank/alibabacloud_ai_search_rerank` to create an inference endpoint that performs a rerank task.", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-bge-reranker-larger\",\n \"host\": \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"workspace\": \"default\"\n }\n}" + }, + "PutAlibabaCloudRequestExample3": { + "summary": "A sparse embedding task", + "description": "Run `PUT _inference/sparse_embedding/alibabacloud_ai_search_sparse` to create an inference endpoint that performs perform a sparse embedding task.", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-text-sparse-embedding-001\",\n \"host\": \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"workspace\": \"default\"\n }\n}" + }, + "PutAlibabaCloudRequestExample4": { + "summary": "A text embedding task", + "description": "Run `PUT _inference/text_embedding/alibabacloud_ai_search_embeddings` to create an inference endpoint that performs a text embedding task.", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-text-embedding-001\",\n \"host\": \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"workspace\": \"default\"\n }\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/inference._types:InferenceEndpointInfo" + } + } + } + } + }, + "x-state": "Added in 8.16.0" + } + }, "/_inference/{task_type}/{huggingface_inference_id}": { "put": { "tags": [ @@ -76982,39 +77078,52 @@ "inference._types:ServiceSettings": { "type": "object" }, - "inference.put_hugging_face:HuggingFaceTaskType": { + "inference.put_alibabacloud:AlibabaCloudTaskType": { "type": "string", "enum": [ + "completion", + "rerank", + "space_embedding", "text_embedding" ] }, - "inference.put_hugging_face:ServiceType": { + "inference.put_alibabacloud:ServiceType": { "type": "string", "enum": [ - "hugging_face" + "alibabacloud-ai-search" ] }, - "inference.put_hugging_face:HuggingFaceServiceSettings": { + "inference.put_alibabacloud:AlibabaCloudServiceSettings": { "type": "object", "properties": { "api_key": { + "description": "A valid API key for the AlibabaCloud AI Search API.", + "type": "string" + }, + "host": { "externalDocs": { - "url": "https://huggingface.co/settings/tokens" + "url": "https://opensearch.console.aliyun.com/cn-shanghai/rag/api-key" }, - "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.", + "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": { "$ref": "#/components/schemas/inference._types:RateLimitSetting" }, - "url": { - "description": "The URL endpoint to use for the requests.", + "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", - "url" + "host", + "service_id", + "workspace" ] }, "inference._types:RateLimitSetting": { @@ -77026,6 +77135,54 @@ } } }, + "inference.put_alibabacloud: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.put_hugging_face:HuggingFaceTaskType": { + "type": "string", + "enum": [ + "text_embedding" + ] + }, + "inference.put_hugging_face:ServiceType": { + "type": "string", + "enum": [ + "hugging_face" + ] + }, + "inference.put_hugging_face: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": { + "$ref": "#/components/schemas/inference._types:RateLimitSetting" + }, + "url": { + "description": "The URL endpoint to use for the requests.", + "type": "string" + } + }, + "required": [ + "api_key", + "url" + ] + }, "inference.put_jinaai:JinaAITaskType": { "type": "string", "enum": [ diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index c4dc4a5584..93ddd23a15 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -9574,6 +9574,102 @@ "x-state": "Added in 9.0.0" } }, + "/_inference/{task_type}/{alibabacloud_inference_id}": { + "put": { + "tags": [ + "inference" + ], + "summary": "Create an AlibabaCloud AI Search inference endpoint", + "description": "Create an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", + "operationId": "inference-put-alibabacloud", + "parameters": [ + { + "in": "path", + "name": "task_type", + "description": "The type of the inference task that the model will perform.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/inference.put_alibabacloud:AlibabaCloudTaskType" + }, + "style": "simple" + }, + { + "in": "path", + "name": "alibabacloud_inference_id", + "description": "The unique identifier of the inference endpoint.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "chunking_settings": { + "$ref": "#/components/schemas/inference._types:InferenceChunkingSettings" + }, + "service": { + "$ref": "#/components/schemas/inference.put_alibabacloud:ServiceType" + }, + "service_settings": { + "$ref": "#/components/schemas/inference.put_alibabacloud:AlibabaCloudServiceSettings" + }, + "task_settings": { + "$ref": "#/components/schemas/inference.put_alibabacloud:AlibabaCloudTaskSettings" + } + }, + "required": [ + "service", + "service_settings" + ] + }, + "examples": { + "PutAlibabaCloudRequestExample1": { + "summary": "A completion task", + "description": "Run `PUT _inference/completion/alibabacloud_ai_search_completion` to create an inference endpoint that performs a completion task.", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"host\" : \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-qwen-turbo\",\n \"workspace\" : \"default\"\n }\n}" + }, + "PutAlibabaCloudRequestExample2": { + "summary": "A rerank task", + "description": "Run `PUT _inference/rerank/alibabacloud_ai_search_rerank` to create an inference endpoint that performs a rerank task.", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-bge-reranker-larger\",\n \"host\": \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"workspace\": \"default\"\n }\n}" + }, + "PutAlibabaCloudRequestExample3": { + "summary": "A sparse embedding task", + "description": "Run `PUT _inference/sparse_embedding/alibabacloud_ai_search_sparse` to create an inference endpoint that performs perform a sparse embedding task.", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-text-sparse-embedding-001\",\n \"host\": \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"workspace\": \"default\"\n }\n}" + }, + "PutAlibabaCloudRequestExample4": { + "summary": "A text embedding task", + "description": "Run `PUT _inference/text_embedding/alibabacloud_ai_search_embeddings` to create an inference endpoint that performs a text embedding task.", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-text-embedding-001\",\n \"host\": \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"workspace\": \"default\"\n }\n}" + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/inference._types:InferenceEndpointInfo" + } + } + } + } + }, + "x-state": "Added in 8.16.0" + } + }, "/_inference/{task_type}/{huggingface_inference_id}": { "put": { "tags": [ @@ -48178,39 +48274,52 @@ "inference._types:ServiceSettings": { "type": "object" }, - "inference.put_hugging_face:HuggingFaceTaskType": { + "inference.put_alibabacloud:AlibabaCloudTaskType": { "type": "string", "enum": [ + "completion", + "rerank", + "space_embedding", "text_embedding" ] }, - "inference.put_hugging_face:ServiceType": { + "inference.put_alibabacloud:ServiceType": { "type": "string", "enum": [ - "hugging_face" + "alibabacloud-ai-search" ] }, - "inference.put_hugging_face:HuggingFaceServiceSettings": { + "inference.put_alibabacloud:AlibabaCloudServiceSettings": { "type": "object", "properties": { "api_key": { + "description": "A valid API key for the AlibabaCloud AI Search API.", + "type": "string" + }, + "host": { "externalDocs": { - "url": "https://huggingface.co/settings/tokens" + "url": "https://opensearch.console.aliyun.com/cn-shanghai/rag/api-key" }, - "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.", + "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": { "$ref": "#/components/schemas/inference._types:RateLimitSetting" }, - "url": { - "description": "The URL endpoint to use for the requests.", + "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", - "url" + "host", + "service_id", + "workspace" ] }, "inference._types:RateLimitSetting": { @@ -48222,6 +48331,54 @@ } } }, + "inference.put_alibabacloud: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.put_hugging_face:HuggingFaceTaskType": { + "type": "string", + "enum": [ + "text_embedding" + ] + }, + "inference.put_hugging_face:ServiceType": { + "type": "string", + "enum": [ + "hugging_face" + ] + }, + "inference.put_hugging_face: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": { + "$ref": "#/components/schemas/inference._types:RateLimitSetting" + }, + "url": { + "description": "The URL endpoint to use for the requests.", + "type": "string" + } + }, + "required": [ + "api_key", + "url" + ] + }, "inference.put_jinaai:JinaAITaskType": { "type": "string", "enum": [ diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 52952acaf4..4eb9ca05e2 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -4591,6 +4591,51 @@ } ] }, + { + "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, + "stack": { + "since": "8.16.0", + "stability": "stable", + "visibility": "public" + } + }, + "description": "Create an AlibabaCloud AI Search inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", + "docId": "inference-api-put-alibabacloud", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-alibabacloud-ai-search.html", + "name": "inference.put_alibabacloud", + "privileges": { + "cluster": [ + "manage_inference" + ] + }, + "request": { + "name": "Request", + "namespace": "inference.put_alibabacloud" + }, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "inference.put_alibabacloud" + }, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{alibabacloud_inference_id}" + } + ] + }, { "availability": { "serverless": { @@ -26978,37 +27023,66 @@ } }, { - "description": "The type of service supported for the specified task type. In this case, `hugging_face`.", +<<<<<<< HEAD +======= + "description": "The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`.", "name": "service", "required": true, "type": { "kind": "instance_of", "type": { "name": "ServiceType", - "namespace": "inference.put_hugging_face" + "namespace": "inference.put_alibabacloud" } } }, { - "description": "Settings used to install the inference model. These settings are specific to the `hugging_face` service.", + "description": "Settings used to install the inference model. These settings are specific to the `alibabacloud-ai-search` service.", "name": "service_settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "HuggingFaceServiceSettings", - "namespace": "inference.put_hugging_face" + "name": "AlibabaCloudServiceSettings", + "namespace": "inference.put_alibabacloud" + } + } + }, + { + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "name": "task_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AlibabaCloudTaskSettings", + "namespace": "inference.put_alibabacloud" } } } ] }, - "description": "Create a Hugging Face inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `hugging_face` service.\n\nYou must first create an inference endpoint on the Hugging Face endpoint page to get an endpoint URL.\nSelect the model you want to use on the new endpoint creation page (for example `intfloat/e5-small-v2`), then select the sentence embeddings task under the advanced configuration section.\nCreate the endpoint and copy the URL after the endpoint initialization has been finished.\n\nThe following models are recommended for the Hugging Face service:\n\n* `all-MiniLM-L6-v2`\n* `all-MiniLM-L12-v2`\n* `all-mpnet-base-v2`\n* `e5-base-v2`\n* `e5-small-v2`\n* `multilingual-e5-base`\n* `multilingual-e5-small`\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", + "description": "Create an AlibabaCloud AI Search inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "examples": { - "PutHuggingFaceRequestExample1": { - "description": "Run `PUT _inference/text_embedding/hugging-face-embeddings` to create an inference endpoint that performs a `text_embedding` task type.", + "PutAlibabaCloudRequestExample1": { + "description": "Run `PUT _inference/completion/alibabacloud_ai_search_completion` to create an inference endpoint that performs a completion task.", + "summary": "A completion task", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"host\" : \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-qwen-turbo\",\n \"workspace\" : \"default\"\n }\n}" + }, + "PutAlibabaCloudRequestExample2": { + "description": "Run `PUT _inference/rerank/alibabacloud_ai_search_rerank` to create an inference endpoint that performs a rerank task.", + "summary": "A rerank task", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-bge-reranker-larger\",\n \"host\": \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"workspace\": \"default\"\n }\n}" + }, + "PutAlibabaCloudRequestExample3": { + "description": "Run `PUT _inference/sparse_embedding/alibabacloud_ai_search_sparse` to create an inference endpoint that performs perform a sparse embedding task.", + "summary": "A sparse embedding task", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-text-sparse-embedding-001\",\n \"host\": \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"workspace\": \"default\"\n }\n}" + }, + "PutAlibabaCloudRequestExample4": { + "description": "Run `PUT _inference/text_embedding/alibabacloud_ai_search_embeddings` to create an inference endpoint that performs a text embedding task.", "summary": "A text embedding task", - "value": "{\n \"service\": \"hugging_face\",\n \"service_settings\": {\n \"api_key\": \"hugging-face-access-token\", \n \"url\": \"url-endpoint\" \n }\n}" + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-text-embedding-001\",\n \"host\": \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"workspace\": \"default\"\n }\n}" } }, "inherits": { @@ -27020,7 +27094,7 @@ "kind": "request", "name": { "name": "Request", - "namespace": "inference.put_hugging_face" + "namespace": "inference.put_alibabacloud" }, "path": [ { @@ -27030,14 +27104,14 @@ "type": { "kind": "instance_of", "type": { - "name": "HuggingFaceTaskType", - "namespace": "inference.put_hugging_face" + "name": "AlibabaCloudTaskType", + "namespace": "inference.put_alibabacloud" } } }, { "description": "The unique identifier of the inference endpoint.", - "name": "huggingface_inference_id", + "name": "alibabacloud_inference_id", "required": true, "type": { "kind": "instance_of", @@ -27049,7 +27123,7 @@ } ], "query": [], - "specLocation": "inference/put_hugging_face/PutHuggingFaceRequest.ts#L27-L89" + "specLocation": "inference/put_alibabacloud/PutAlibabaCloudRequest.ts#L27-L80" }, { "body": { @@ -27065,9 +27139,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "inference.put_hugging_face" + "namespace": "inference.put_alibabacloud" }, - "specLocation": "inference/put_hugging_face/PutHuggingFaceResponse.ts#L22-L24" + "specLocation": "inference/put_alibabacloud/PutAlibabaCloudResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -27091,26 +27165,26 @@ } }, { - "description": "The type of service supported for the specified task type. In this case, `openai`.", + "description": "The type of service supported for the specified task type. In this case, `amazonbedrock`.", "name": "service", "required": true, "type": { "kind": "instance_of", "type": { "name": "ServiceType", - "namespace": "inference.put_openai" + "namespace": "inference.put_amazonbedrock" } } }, { - "description": "Settings used to install the inference model. These settings are specific to the `openai` service.", + "description": "Settings used to install the inference model. These settings are specific to the `amazonbedrock` service.", "name": "service_settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "OpenAIServiceSettings", - "namespace": "inference.put_openai" + "name": "AmazonBedrockServiceSettings", + "namespace": "inference.put_amazonbedrock" } } }, @@ -27121,21 +27195,21 @@ "type": { "kind": "instance_of", "type": { - "name": "OpenAITaskSettings", - "namespace": "inference.put_openai" + "name": "AmazonBedrockTaskSettings", + "namespace": "inference.put_amazonbedrock" } } } ] }, - "description": "Create an OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openai` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", + "description": "Create an Amazon Bedrock inference endpoint.\n\nCreates an inference endpoint to perform an inference task with the `amazonbedrock` service.\n\n>info\n> You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "examples": { - "PutOpenAiRequestExample1": { - "description": "Run `PUT _inference/text_embedding/openai-embeddings` to create an inference endpoint that performs a `text_embedding` task. The embeddings created by requests to this endpoint will have 128 dimensions.", + "PutAmazonBedrockRequestExample1": { + "description": "Run `PUT _inference/text_embedding/amazon_bedrock_embeddings` to create an inference endpoint that performs a text embedding task.", "summary": "A text embedding task", - "value": "{\n \"service\": \"openai\",\n \"service_settings\": {\n \"api_key\": \"OpenAI-API-Key\",\n \"model_id\": \"text-embedding-3-small\",\n \"dimensions\": 128\n }\n}" + "value": "{\n \"service\": \"amazonbedrock\",\n \"service_settings\": {\n \"access_key\": \"AWS-access-key\",\n \"secret_key\": \"AWS-secret-key\",\n \"region\": \"us-east-1\",\n \"provider\": \"amazontitan\",\n \"model\": \"amazon.titan-embed-text-v2:0\"\n }\n}" }, - "PutOpenAiRequestExample2": { + "PutAmazonBedrockRequestExample2": { "description": "Run `PUT _inference/completion/openai-completion` to create an inference endpoint to perform a completion task type.", "summary": "A completion task", "value": "{\n \"service\": \"openai\",\n \"service_settings\": {\n \"api_key\": \"OpenAI-API-Key\",\n \"model_id\": \"gpt-3.5-turbo\"\n }\n}" @@ -27150,24 +27224,24 @@ "kind": "request", "name": { "name": "Request", - "namespace": "inference.put_openai" + "namespace": "inference.put_amazonbedrock" }, "path": [ { - "description": "The type of the inference task that the model will perform.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.", + "description": "The type of the inference task that the model will perform.", "name": "task_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "OpenAITaskType", - "namespace": "inference.put_openai" + "name": "AmazonBedrockTaskType", + "namespace": "inference.put_amazonbedrock" } } }, { "description": "The unique identifier of the inference endpoint.", - "name": "openai_inference_id", + "name": "amazonbedrock_inference_id", "required": true, "type": { "kind": "instance_of", @@ -27179,7 +27253,7 @@ } ], "query": [], - "specLocation": "inference/put_openai/PutOpenAiRequest.ts#L28-L82" + "specLocation": "inference/put_amazonbedrock/PutAmazonBedrockRequest.ts#L28-L84" }, { "body": { @@ -27195,9 +27269,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "inference.put_openai" + "namespace": "inference.put_amazonbedrock" }, - "specLocation": "inference/put_openai/PutOpenAiResponse.ts#L22-L24" + "specLocation": "inference/put_amazonbedrock/PutAmazonBedrockResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -27207,14 +27281,28 @@ "kind": "properties", "properties": [ { - "description": "The type of service supported for the specified task type. In this case, `watsonxai`.", + "description": "The chunking configuration object.", + "extDocId": "inference-chunking", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "name": "chunking_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InferenceChunkingSettings", + "namespace": "inference._types" + } + } + }, + { + "description": "The type of service supported for the specified task type. In this case, `anthropic`.", "name": "service", "required": true, "type": { "kind": "instance_of", "type": { "name": "ServiceType", - "namespace": "inference.put_watsonx" + "namespace": "inference.put_anthropic" } } }, @@ -27225,18 +27313,30 @@ "type": { "kind": "instance_of", "type": { - "name": "WatsonxServiceSettings", - "namespace": "inference.put_watsonx" + "name": "AnthropicServiceSettings", + "namespace": "inference.put_anthropic" + } + } + }, + { + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "name": "task_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AnthropicTaskSettings", + "namespace": "inference.put_anthropic" } } } ] }, - "description": "Create a Watsonx inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `watsonxai` service.\nYou need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service.\nYou can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", + "description": "Create an Anthropic inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `anthropic` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "examples": { - "InferenceRequestExample1": { - "description": "Run `PUT _inference/text_embedding/watsonx-embeddings` to create an Watonsx inference endpoint that performs a text embedding task.", - "value": "{\n \"service\": \"watsonxai\",\n \"service_settings\": {\n \"api_key\": \"Watsonx-API-Key\", \n \"url\": \"Wastonx-URL\", \n \"model_id\": \"ibm/slate-30m-english-rtrvr\",\n \"project_id\": \"IBM-Cloud-ID\", \n \"api_version\": \"2024-03-14\"\n }\n}" + "PutAnthropicRequestExample1": { + "description": "Run `PUT _inference/completion/anthropic_completion` to create an inference endpoint that performs a completion task.", + "value": "{\n \"service\": \"anthropic\",\n \"service_settings\": {\n \"api_key\": \"Anthropic-Api-Key\",\n \"model_id\": \"Model-ID\"\n },\n \"task_settings\": {\n \"max_tokens\": 1024\n }\n}" } }, "inherits": { @@ -27248,24 +27348,24 @@ "kind": "request", "name": { "name": "Request", - "namespace": "inference.put_watsonx" + "namespace": "inference.put_anthropic" }, "path": [ { - "description": "The task type.\nThe only valid task type for the model to perform is `text_embedding`.", + "description": "The task type.\nThe only valid task type for the model to perform is `completion`.", "name": "task_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "WatsonxTaskType", - "namespace": "inference.put_watsonx" + "name": "AnthropicTaskType", + "namespace": "inference.put_anthropic" } } }, { "description": "The unique identifier of the inference endpoint.", - "name": "watsonx_inference_id", + "name": "anthropic_inference_id", "required": true, "type": { "kind": "instance_of", @@ -27277,7 +27377,7 @@ } ], "query": [], - "specLocation": "inference/put_watsonx/PutWatsonxRequest.ts#L24-L70" + "specLocation": "inference/put_anthropic/PutAnthropicRequest.ts#L28-L82" }, { "body": { @@ -27293,9 +27393,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "inference.put_watsonx" + "namespace": "inference.put_anthropic" }, - "specLocation": "inference/put_watsonx/PutWatsonxResponse.ts#L22-L24" + "specLocation": "inference/put_anthropic/PutAnthropicResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -27305,64 +27405,68 @@ "kind": "properties", "properties": [ { - "description": "Query input.", - "name": "query", + "description": "The chunking configuration object.", + "extDocId": "inference-chunking", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "name": "chunking_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InferenceChunkingSettings", + "namespace": "inference._types" + } + } + }, + { + "description": "The type of service supported for the specified task type. In this case, `azureaistudio`.", + "name": "service", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ServiceType", + "namespace": "inference.put_azureaistudio" } } }, { - "description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\n> info\n> Inference endpoints for the `completion` task type currently only support a single string as input.", - "name": "input", + "description": "Settings used to install the inference model. These settings are specific to the `openai` service.", + "name": "service_settings", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "AzureAiStudioServiceSettings", + "namespace": "inference.put_azureaistudio" + } } }, { - "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.", + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "name": "task_settings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TaskSettings", - "namespace": "inference._types" + "name": "AzureAiStudioTaskSettings", + "namespace": "inference.put_azureaistudio" } } } ] }, - "description": "Perform rereanking inference on the service", + "description": "Create an Azure AI studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `azureaistudio` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "examples": { - "RerankRequestExample1": { - "description": "Run `POST _inference/rerank/cohere_rerank` to perform reranking on the example input.", - "summary": "Rerank task", - "value": "{\n \"input\": [\"luke\", \"like\", \"leia\", \"chewy\",\"r2d2\", \"star\", \"wars\"],\n \"query\": \"star wars main character\"\n}" + "PutAzureAiStudioRequestExample1": { + "description": "Run `PUT _inference/text_embedding/azure_ai_studio_embeddings` to create an inference endpoint that performs a text_embedding task. Note that you do not specify a model here, as it is defined already in the Azure AI Studio deployment.", + "summary": "A text embedding task", + "value": "{\n \"service\": \"azureaistudio\",\n \"service_settings\": {\n \"api_key\": \"Azure-AI-Studio-API-key\",\n \"target\": \"Target-Uri\",\n \"provider\": \"openai\",\n \"endpoint_type\": \"token\"\n }\n}" + }, + "PutAzureAiStudioRequestExample2": { + "description": "Run `PUT _inference/completion/azure_ai_studio_completion` to create an inference endpoint that performs a completion task.", + "summary": "A completion task", + "value": "{\n \"service\": \"azureaistudio\",\n \"service_settings\": {\n \"api_key\": \"Azure-AI-Studio-API-key\",\n \"target\": \"Target-URI\",\n \"provider\": \"databricks\",\n \"endpoint_type\": \"realtime\"\n }\n}" } }, "inherits": { @@ -27374,38 +27478,36 @@ "kind": "request", "name": { "name": "Request", - "namespace": "inference.rerank" + "namespace": "inference.put_azureaistudio" }, "path": [ { - "description": "The unique identifier for the inference endpoint.", - "name": "inference_id", + "description": "The type of the inference task that the model will perform.", + "name": "task_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "AzureAiStudioTaskType", + "namespace": "inference.put_azureaistudio" } } - } - ], - "query": [ + }, { - "description": "The amount of time to wait for the inference request to complete.", - "name": "timeout", - "required": false, - "serverDefault": "30s", + "description": "The unique identifier of the inference endpoint.", + "name": "azureaistudio_inference_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "Id", "namespace": "_types" } } } ], - "specLocation": "inference/rerank/RerankRequest.ts#L25-L72" + "query": [], + "specLocation": "inference/put_azureaistudio/PutAzureAiStudioRequest.ts#L28-L81" }, { "body": { @@ -27413,24 +27515,17 @@ "value": { "kind": "instance_of", "type": { - "name": "RerankedInferenceResult", + "name": "InferenceEndpointInfo", "namespace": "inference._types" } } }, - "examples": { - "RerankResponseExample1": { - "description": "A successful response from `POST _inference/rerank/cohere_rerank`.\n", - "summary": "Rerank task", - "value": "{\n \"rerank\": [\n {\n \"index\": \"2\",\n \"relevance_score\": \"0.011597361\",\n \"text\": \"leia\"\n },\n {\n \"index\": \"0\",\n \"relevance_score\": \"0.006338922\",\n \"text\": \"luke\"\n },\n {\n \"index\": \"5\",\n \"relevance_score\": \"0.0016166499\",\n \"text\": \"star\"\n },\n {\n \"index\": \"4\",\n \"relevance_score\": \"0.0011695103\",\n \"text\": \"r2d2\"\n },\n {\n \"index\": \"1\",\n \"relevance_score\": \"5.614787E-4\",\n \"text\": \"like\"\n },\n {\n \"index\": \"6\",\n \"relevance_score\": \"3.7850367E-4\",\n \"text\": \"wars\"\n },\n {\n \"index\": \"3\",\n \"relevance_score\": \"1.2508839E-5\",\n \"text\": \"chewy\"\n }\n ]\n}" - } - }, "kind": "response", "name": { "name": "Response", - "namespace": "inference.rerank" + "namespace": "inference.put_azureaistudio" }, - "specLocation": "inference/rerank/RerankResponse.ts#L22-L24" + "specLocation": "inference/put_azureaistudio/PutAzureAiStudioResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -27440,52 +27535,68 @@ "kind": "properties", "properties": [ { - "description": "Inference input.\nEither a string or an array of strings.", - "name": "input", + "description": "The chunking configuration object.", + "extDocId": "inference-chunking", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "name": "chunking_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InferenceChunkingSettings", + "namespace": "inference._types" + } + } + }, + { + "description": "The type of service supported for the specified task type. In this case, `azureopenai`.", + "name": "service", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "ServiceType", + "namespace": "inference.put_azureopenai" + } } }, { - "description": "Optional task settings", + "description": "Settings used to install the inference model. These settings are specific to the `azureopenai` service.", + "name": "service_settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AzureOpenAIServiceSettings", + "namespace": "inference.put_azureopenai" + } + } + }, + { + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "name": "task_settings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TaskSettings", - "namespace": "inference._types" + "name": "AzureOpenAITaskSettings", + "namespace": "inference.put_azureopenai" } } } ] }, - "description": "Perform sparse embedding inference on the service", + "description": "Create an Azure OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `azureopenai` service.\n\nThe list of chat completion models that you can choose from in your Azure OpenAI deployment include:\n\n* [GPT-4 and GPT-4 Turbo models](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-4-and-gpt-4-turbo-models)\n* [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35)\n\nThe list of embeddings models that you can choose from in your deployment can be found in the [Azure models documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings).\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "examples": { - "SparseEmbeddingRequestExample1": { - "description": "Run `POST _inference/sparse_embedding/my-elser-model` to perform sparse embedding on the example sentence.", - "summary": "Sparse embedding task", - "value": "{\n \"input\": \"The sky above the port was the color of television tuned to a dead channel.\"\n}" + "PutAzureOpenAiRequestExample1": { + "description": "Run `PUT _inference/text_embedding/azure_openai_embeddings` to create an inference endpoint that performs a `text_embedding` task. You do not specify a model, as it is defined already in the Azure OpenAI deployment.", + "summary": "A text embedding task", + "value": "{\n \"service\": \"azureopenai\",\n \"service_settings\": {\n \"api_key\": \"Api-Key\",\n \"resource_name\": \"Resource-name\",\n \"deployment_id\": \"Deployment-id\",\n \"api_version\": \"2024-02-01\"\n }\n}" + }, + "PutAzureOpenAiRequestExample2": { + "description": "Run `PUT _inference/completion/azure_openai_completion` to create an inference endpoint that performs a `completion` task.", + "summary": "A completion task", + "value": "{\n \"service\": \"azureopenai\",\n \"service_settings\": {\n \"api_key\": \"Api-Key\",\n \"resource_name\": \"Resource-name\",\n \"deployment_id\": \"Deployment-id\",\n \"api_version\": \"2024-02-01\"\n }\n}" } }, "inherits": { @@ -27497,38 +27608,36 @@ "kind": "request", "name": { "name": "Request", - "namespace": "inference.sparse_embedding" + "namespace": "inference.put_azureopenai" }, "path": [ { - "description": "The inference Id", - "name": "inference_id", + "description": "The type of the inference task that the model will perform.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.", + "name": "task_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "AzureOpenAITaskType", + "namespace": "inference.put_azureopenai" } } - } - ], - "query": [ + }, { - "description": "Specifies the amount of time to wait for the inference request to complete.", - "name": "timeout", - "required": false, - "serverDefault": "30s", + "description": "The unique identifier of the inference endpoint.", + "name": "azureopenai_inference_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "Id", "namespace": "_types" } } } ], - "specLocation": "inference/sparse_embedding/SparseEmbeddingRequest.ts#L25-L63" + "query": [], + "specLocation": "inference/put_azureopenai/PutAzureOpenAiRequest.ts#L27-L88" }, { "body": { @@ -27536,24 +27645,17 @@ "value": { "kind": "instance_of", "type": { - "name": "SparseEmbeddingInferenceResult", + "name": "InferenceEndpointInfo", "namespace": "inference._types" } } }, - "examples": { - "SparseEmbeddingResponseExample1": { - "description": "An abbreviated response from `POST _inference/sparse_embedding/my-elser-model`.\n", - "summary": "Sparse embedding task", - "value": "{\n \"sparse_embedding\": [\n {\n \"port\": 2.1259406,\n \"sky\": 1.7073475,\n \"color\": 1.6922266,\n \"dead\": 1.6247464,\n \"television\": 1.3525393,\n \"above\": 1.2425821,\n \"tuned\": 1.1440028,\n \"colors\": 1.1218185,\n \"tv\": 1.0111054,\n \"ports\": 1.0067928,\n \"poem\": 1.0042328,\n \"channel\": 0.99471164,\n \"tune\": 0.96235967,\n \"scene\": 0.9020516\n }\n ]\n}" - } - }, "kind": "response", "name": { "name": "Response", - "namespace": "inference.sparse_embedding" + "namespace": "inference.put_azureopenai" }, - "specLocation": "inference/sparse_embedding/SparseEmbeddingResponse.ts#L22-L24" + "specLocation": "inference/put_azureopenai/PutAzureOpenAiResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -27563,52 +27665,68 @@ "kind": "properties", "properties": [ { - "description": "Inference input.\nEither a string or an array of strings.", - "name": "input", + "description": "The chunking configuration object.", + "extDocId": "inference-chunking", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "name": "chunking_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InferenceChunkingSettings", + "namespace": "inference._types" + } + } + }, + { + "description": "The type of service supported for the specified task type. In this case, `cohere`.", + "name": "service", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "ServiceType", + "namespace": "inference.put_cohere" + } } }, { - "description": "Optional task settings", + "description": "Settings used to install the inference model.\nThese settings are specific to the `cohere` service.", + "name": "service_settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "CohereServiceSettings", + "namespace": "inference.put_cohere" + } + } + }, + { + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "name": "task_settings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TaskSettings", - "namespace": "inference._types" + "name": "CohereTaskSettings", + "namespace": "inference.put_cohere" } } } ] }, - "description": "Perform text embedding inference on the service", + "description": "Create a Cohere inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `cohere` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "examples": { - "TextEmbeddingRequestExample1": { - "description": "Run `POST _inference/text_embedding/my-cohere-endpoint` to perform text embedding on the example sentence using the Cohere integration,", - "summary": "Text embedding task", - "value": "{\n \"input\": \"The sky above the port was the color of television tuned to a dead channel.\",\n \"task_settings\": {\n \"input_type\": \"ingest\"\n }\n}" + "PutCohereRequestExample1": { + "description": "Run `PUT _inference/text_embedding/cohere-embeddings` to create an inference endpoint that performs a text embedding task.", + "summary": "A text embedding task", + "value": "{\n \"service\": \"cohere\",\n \"service_settings\": {\n \"api_key\": \"Cohere-Api-key\",\n \"model_id\": \"embed-english-light-v3.0\",\n \"embedding_type\": \"byte\"\n }\n}" + }, + "PutCohereRequestExample2": { + "description": "Run `PUT _inference/rerank/cohere-rerank` to create an inference endpoint that performs a rerank task.", + "summary": "A rerank task", + "value": "{\n \"service\": \"cohere\",\n \"service_settings\": {\n \"api_key\": \"Cohere-API-key\",\n \"model_id\": \"rerank-english-v3.0\"\n },\n \"task_settings\": {\n \"top_n\": 10,\n \"return_documents\": true\n }\n}" } }, "inherits": { @@ -27620,38 +27738,36 @@ "kind": "request", "name": { "name": "Request", - "namespace": "inference.text_embedding" + "namespace": "inference.put_cohere" }, "path": [ { - "description": "The inference Id", - "name": "inference_id", + "description": "The type of the inference task that the model will perform.", + "name": "task_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "CohereTaskType", + "namespace": "inference.put_cohere" } } - } - ], - "query": [ + }, { - "description": "Specifies the amount of time to wait for the inference request to complete.", - "name": "timeout", - "required": false, - "serverDefault": "30s", + "description": "The unique identifier of the inference endpoint.", + "name": "cohere_inference_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "Id", "namespace": "_types" } } } ], - "specLocation": "inference/text_embedding/TextEmbeddingRequest.ts#L25-L63" + "query": [], + "specLocation": "inference/put_cohere/PutCohereRequest.ts#L28-L82" }, { "body": { @@ -27659,33 +27775,52 @@ "value": { "kind": "instance_of", "type": { - "name": "TextEmbeddingInferenceResult", + "name": "InferenceEndpointInfo", "namespace": "inference._types" } } }, - "examples": { - "TextEmbeddingResponseExample1": { - "description": "An abbreviated response from `POST _inference/text_embedding/my-cohere-endpoint`.\n", - "summary": "Text embedding task", - "value": "{\n \"text_embedding\": [\n {\n \"embedding\": [\n {\n 0.018569946,\n -0.036895752,\n 0.01486969,\n -0.0045204163,\n -0.04385376,\n 0.0075950623,\n 0.04260254,\n -0.004005432,\n 0.007865906,\n 0.030792236,\n -0.050476074,\n 0.011795044,\n -0.011642456,\n -0.010070801\n }\n ]\n }\n ]\n}" - } - }, "kind": "response", "name": { "name": "Response", - "namespace": "inference.text_embedding" + "namespace": "inference.put_cohere" }, - "specLocation": "inference/text_embedding/TextEmbeddingResponse.ts#L22-L24" + "specLocation": "inference/put_cohere/PutCohereResponse.ts#L22-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "kind": "properties", + "properties": [ + { + "description": "The type of service supported for the specified task type. In this case, `elastic`.", + "name": "service", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ServiceType", + "namespace": "inference.put_eis" + } + } + }, + { + "description": "Settings used to install the inference model. These settings are specific to the `elastic` service.", + "name": "service_settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EisServiceSettings", + "namespace": "inference.put_eis" + } + } + } + ] }, - "description": "Get cluster info.\nGet basic build, version, and cluster information.", + "description": "Create an Elastic Inference Service (EIS) inference endpoint.\n\nCreate an inference endpoint to perform an inference task through the Elastic Inference Service (EIS).", "inherits": { "type": { "name": "RequestBase", @@ -27695,97 +27830,147 @@ "kind": "request", "name": { "name": "Request", - "namespace": "_global.info" + "namespace": "inference.put_eis" }, - "path": [], + "path": [ + { + "description": "The type of the inference task that the model will perform.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.", + "name": "task_type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "EisTaskType", + "namespace": "inference.put_eis" + } + } + }, + { + "description": "The unique identifier of the inference endpoint.", + "name": "eis_inference_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], "query": [], - "specLocation": "_global/info/RootNodeInfoRequest.ts#L22-L39" + "specLocation": "inference/put_eis/PutEisRequest.ts#L24-L62" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceEndpointInfo", + "namespace": "inference._types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "inference.put_eis" + }, + "specLocation": "inference/put_eis/PutEisResponse.ts#L22-L24" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], "body": { "kind": "properties", "properties": [ { - "description": "The responding cluster's name.", - "name": "cluster_name", - "required": true, + "description": "The chunking configuration object.", + "extDocId": "inference-chunking", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "name": "chunking_settings", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "InferenceChunkingSettings", + "namespace": "inference._types" } } }, { - "name": "cluster_uuid", + "description": "The type of service supported for the specified task type. In this case, `elasticsearch`.", + "name": "service", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Uuid", - "namespace": "_types" + "name": "ServiceType", + "namespace": "inference.put_elasticsearch" } } }, { - "description": "The responding node's name.", - "name": "name", + "description": "Settings used to install the inference model. These settings are specific to the `elasticsearch` service.", + "name": "service_settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "ElasticsearchServiceSettings", + "namespace": "inference.put_elasticsearch" } } }, { - "name": "tagline", - "required": true, + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "name": "task_settings", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The running version of Elasticsearch.", - "name": "version", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ElasticsearchVersionInfo", - "namespace": "_types" + "name": "ElasticsearchTaskSettings", + "namespace": "inference.put_elasticsearch" } } } ] }, + "description": "Create an OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elasticsearch` service.\n\n> info\n> Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings.\n\nIf you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "examples": { - "RootNodeInfoResponseExample1": { - "description": "A successful response from `GET /`s.", - "value": "{\n \"name\": \"instance-0000000000\",\n \"cluster_name\": \"my_test_cluster\",\n \"cluster_uuid\": \"5QaxoN0pRZuOmWSxstBBwQ\",\n \"version\": {\n \"build_date\": \"2024-02-01T13:07:13.727175297Z\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"build_hash\": \"6185ba65d27469afabc9bc951cded6c17c21e3f3\",\n \"number\": \"8.12.1\",\n \"lucene_version\": \"9.9.2\",\n \"minimum_index_compatibility_version\": \"7.0.0\",\n \"build_flavor\": \"default\",\n \"build_snapshot\": false,\n \"build_type\": \"docker\"\n },\n \"tagline\": \"You Know, for Search\"\n}" + "PutElasticsearchRequestExample1": { + "description": "Run `PUT _inference/sparse_embedding/my-elser-model` to create an inference endpoint that performs a `sparse_embedding` task. The `model_id` must be the ID of one of the built-in ELSER models. The API will automatically download the ELSER model if it isn't already downloaded and then deploy the model.", + "summary": "ELSER sparse embedding task", + "value": "{\n \"service\": \"elasticsearch\",\n \"service_settings\": {\n \"adaptive_allocations\": { \n \"enabled\": true,\n \"min_number_of_allocations\": 1,\n \"max_number_of_allocations\": 4\n },\n \"num_threads\": 1,\n \"model_id\": \".elser_model_2\" \n }\n}" + }, + "PutElasticsearchRequestExample2": { + "description": "Run `PUT _inference/rerank/my-elastic-rerank` to create an inference endpoint that performs a rerank task using the built-in Elastic Rerank cross-encoder model. The `model_id` must be `.rerank-v1`, which is the ID of the built-in Elastic Rerank model. The API will automatically download the Elastic Rerank model if it isn't already downloaded and then deploy the model. Once deployed, the model can be used for semantic re-ranking with a `text_similarity_reranker` retriever.", + "summary": "Elastic rerank task", + "value": "{\n \"service\": \"elasticsearch\",\n \"service_settings\": {\n \"model_id\": \".rerank-v1\", \n \"num_threads\": 1,\n \"adaptive_allocations\": { \n \"enabled\": true,\n \"min_number_of_allocations\": 1,\n \"max_number_of_allocations\": 4\n }\n }\n}" + }, + "PutElasticsearchRequestExample3": { + "description": "Run `PUT _inference/text_embedding/my-e5-model` to create an inference endpoint that performs a `text_embedding` task. The `model_id` must be the ID of one of the built-in E5 models. The API will automatically download the E5 model if it isn't already downloaded and then deploy the model.", + "summary": "E5 text embedding task", + "value": "{\n \"service\": \"elasticsearch\",\n \"service_settings\": {\n \"num_allocations\": 1,\n \"num_threads\": 1,\n \"model_id\": \".multilingual-e5-small\" \n }\n}" + }, + "PutElasticsearchRequestExample4": { + "description": "Run `PUT _inference/text_embedding/my-msmarco-minilm-model` to create an inference endpoint that performs a `text_embedding` task with a model that was uploaded by Eland.", + "summary": "Eland text embedding task", + "value": "{\n \"service\": \"elasticsearch\",\n \"service_settings\": {\n \"num_allocations\": 1,\n \"num_threads\": 1,\n \"model_id\": \"msmarco-MiniLM-L12-cos-v5\" \n }\n}" + }, + "PutElasticsearchRequestExample5": { + "description": "Run `PUT _inference/text_embedding/my-e5-model` to create an inference endpoint that performs a `text_embedding` task and to configure adaptive allocations. The API request will automatically download the E5 model if it isn't already downloaded and then deploy the model.", + "summary": "Adaptive allocation", + "value": "{\n \"service\": \"elasticsearch\",\n \"service_settings\": {\n \"adaptive_allocations\": {\n \"enabled\": true,\n \"min_number_of_allocations\": 3,\n \"max_number_of_allocations\": 10\n },\n \"num_threads\": 1,\n \"model_id\": \".multilingual-e5-small\"\n }\n}" + }, + "PutElasticsearchRequestExample6": { + "description": "Run `PUT _inference/sparse_embedding/use_existing_deployment` to use an already existing model deployment when creating an inference endpoint.", + "summary": "Existing model deployment", + "value": "{\n \"service\": \"elasticsearch\",\n \"service_settings\": {\n \"deployment_id\": \".elser_model_2\"\n }\n}" } }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "_global.info" - }, - "specLocation": "_global/info/RootNodeInfoResponse.ts#L23-L40" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Delete pipelines.\nDelete one or more ingest pipelines.", "inherits": { "type": { "name": "RequestBase", @@ -27795,51 +27980,36 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ingest.delete_pipeline" + "namespace": "inference.put_elasticsearch" }, "path": [ { - "description": "Pipeline ID or wildcard expression of pipeline IDs used to limit the request.\nTo delete all ingest pipelines in a cluster, use a value of `*`.", - "name": "id", + "description": "The type of the inference task that the model will perform.", + "name": "task_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "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.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" + "name": "ElasticsearchTaskType", + "namespace": "inference.put_elasticsearch" } } }, { - "description": "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", + "description": "The unique identifier of the inference endpoint.\nThe must not match the `model_id`.", + "name": "elasticsearch_inference_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "Id", "namespace": "_types" } } } ], - "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L61" + "query": [], + "specLocation": "inference/put_elasticsearch/PutElasticsearchRequest.ts#L25-L86" }, { "body": { @@ -27847,26 +28017,88 @@ "value": { "kind": "instance_of", "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "name": "InferenceEndpointInfo", + "namespace": "inference._types" } } }, + "examples": { + "PutElasticsearchResponseExample1": { + "description": "A successful response from `PUT _inference/sparse_embedding/use_existing_deployment`. It contains the model ID and the threads and allocations settings from the model deployment.\n", + "value": "{\n \"inference_id\": \"use_existing_deployment\",\n \"task_type\": \"sparse_embedding\",\n \"service\": \"elasticsearch\",\n \"service_settings\": {\n \"num_allocations\": 2,\n \"num_threads\": 1,\n \"model_id\": \".elser_model_2\",\n \"deployment_id\": \".elser_model_2\"\n },\n \"chunking_settings\": {\n \"strategy\": \"sentence\",\n \"max_chunk_size\": 250,\n \"sentence_overlap\": 1\n }\n}" + } + }, "kind": "response", "name": { "name": "Response", - "namespace": "ingest.delete_pipeline" + "namespace": "inference.put_elasticsearch" }, - "specLocation": "ingest/delete_pipeline/DeletePipelineResponse.ts#L22-L24" + "specLocation": "inference/put_elasticsearch/PutElasticsearchResponse.ts#L22-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "kind": "properties", + "properties": [ + { + "description": "The chunking configuration object.", + "extDocId": "inference-chunking", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "name": "chunking_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InferenceChunkingSettings", + "namespace": "inference._types" + } + } + }, + { + "description": "The type of service supported for the specified task type. In this case, `elser`.", + "name": "service", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ServiceType", + "namespace": "inference.put_elser" + } + } + }, + { + "description": "Settings used to install the inference model. These settings are specific to the `elser` service.", + "name": "service_settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ElserServiceSettings", + "namespace": "inference.put_elser" + } + } + } + ] + }, + "deprecation": { + "description": "The elser service is deprecated and will be removed in a future release. Use the Elasticsearch inference integration instead, with model_id included in the service_settings.", + "version": "8.16.0" + }, + "description": "Create an ELSER inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elser` service.\nYou can also deploy ELSER by using the Elasticsearch inference integration.\n\n> info\n> Your Elasticsearch deployment contains a preconfigured ELSER inference endpoint, you only need to create the enpoint using the API if you want to customize the settings.\n\nThe API request will automatically download and deploy the ELSER model if it isn't already downloaded.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", + "examples": { + "PutElserRequestExample1": { + "description": "Run `PUT _inference/sparse_embedding/my-elser-model` to create an inference endpoint that performs a `sparse_embedding` task. The request will automatically download the ELSER model if it isn't already downloaded and then deploy the model.", + "summary": "A sparse embedding task", + "value": "{\n \"service\": \"elser\",\n \"service_settings\": {\n \"num_allocations\": 1,\n \"num_threads\": 1\n }\n}" + }, + "PutElserRequestExample2": { + "description": "Run `PUT _inference/sparse_embedding/my-elser-model` to create an inference endpoint that performs a `sparse_embedding` task with adaptive allocations. When adaptive allocations are enabled, the number of allocations of the model is set automatically based on the current load.", + "summary": "Adaptive allocations", + "value": "{\n \"service\": \"elser\",\n \"service_settings\": {\n \"adaptive_allocations\": {\n \"enabled\": true,\n \"min_number_of_allocations\": 3,\n \"max_number_of_allocations\": 10\n },\n \"num_threads\": 1\n }\n}" + } }, - "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -27876,96 +28108,116 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ingest.get_pipeline" + "namespace": "inference.put_elser" }, "path": [ { - "description": "Comma-separated list of pipeline IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all ingest pipelines, omit this parameter or use `*`.", - "name": "id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "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.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", + "description": "The type of the inference task that the model will perform.", + "name": "task_type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "ElserTaskType", + "namespace": "inference.put_elser" } } }, { - "description": "Return pipelines without their definitions (default: false)", - "name": "summary", - "required": false, - "serverDefault": false, + "description": "The unique identifier of the inference endpoint.", + "name": "elser_inference_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } } ], - "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L64" + "query": [], + "specLocation": "inference/put_elser/PutElserRequest.ts#L25-L82" }, { "body": { - "codegenName": "pipelines", "kind": "value", "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Pipeline", - "namespace": "ingest._types" - } + "kind": "instance_of", + "type": { + "name": "InferenceEndpointInfo", + "namespace": "inference._types" } } }, "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 }\n}" + "PutElserResponseExample1": { + "description": "A successful response when creating an ELSER inference endpoint.", + "value": "{\n \"inference_id\": \"my-elser-model\",\n \"task_type\": \"sparse_embedding\",\n \"service\": \"elser\",\n \"service_settings\": {\n \"num_allocations\": 1,\n \"num_threads\": 1\n },\n \"task_settings\": {}\n}" } }, "kind": "response", "name": { "name": "Response", - "namespace": "ingest.get_pipeline" + "namespace": "inference.put_elser" }, - "specLocation": "ingest/get_pipeline/GetPipelineResponse.ts#L23-L26" + "specLocation": "inference/put_elser/PutElserResponse.ts#L22-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "kind": "properties", + "properties": [ + { + "description": "The chunking configuration object.", + "extDocId": "inference-chunking", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "name": "chunking_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InferenceChunkingSettings", + "namespace": "inference._types" + } + } + }, + { + "description": "The type of service supported for the specified task type. In this case, `googleaistudio`.", + "name": "service", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ServiceType", + "namespace": "inference.put_googleaistudio" + } + } + }, + { + "description": "Settings used to install the inference model. These settings are specific to the `googleaistudio` service.", + "name": "service_settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "GoogleAiStudioServiceSettings", + "namespace": "inference.put_googleaistudio" + } + } + } + ] + }, + "description": "Create an Google AI Studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googleaistudio` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", + "examples": { + "PutGoogleAiStudioRequestExample1": { + "description": "Run `PUT _inference/completion/google_ai_studio_completion` to create an inference endpoint to perform a `completion` task type.", + "summary": "A completion task", + "value": "{\n \"service\": \"googleaistudio\",\n \"service_settings\": {\n \"api_key\": \"api-key\",\n \"model_id\": \"model-id\"\n }\n}" + } }, - "description": "Run a grok processor.\nExtract structured fields out of a single text field within a document.\nYou must 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.", "inherits": { "type": { "name": "RequestBase", @@ -27975,46 +28227,54 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ingest.processor_grok" + "namespace": "inference.put_googleaistudio" }, - "path": [], + "path": [ + { + "description": "The type of the inference task that the model will perform.", + "name": "task_type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "GoogleAiStudioTaskType", + "namespace": "inference.put_googleaistudio" + } + } + }, + { + "description": "The unique identifier of the inference endpoint.", + "name": "googleaistudio_inference_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], "query": [], - "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L40" + "specLocation": "inference/put_googleaistudio/PutGoogleAiStudioRequest.ts#L27-L75" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "patterns", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceEndpointInfo", + "namespace": "inference._types" } - ] + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ingest.processor_grok" + "namespace": "inference.put_googleaistudio" }, - "specLocation": "ingest/processor_grok/GrokProcessorPatternsResponse.ts#L22-L24" + "specLocation": "inference/put_googleaistudio/PutGoogleAiStudioResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -28024,96 +28284,68 @@ "kind": "properties", "properties": [ { - "description": "Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.", - "name": "_meta", + "description": "The chunking configuration object.", + "extDocId": "inference-chunking", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "name": "chunking_settings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Metadata", - "namespace": "_types" + "name": "InferenceChunkingSettings", + "namespace": "inference._types" } } }, { - "description": "Description of the ingest pipeline.", - "name": "description", - "required": false, + "description": "The type of service supported for the specified task type. In this case, `googlevertexai`.", + "name": "service", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.", - "name": "on_failure", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ProcessorContainer", - "namespace": "ingest._types" - } - } - } - }, - { - "description": "Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.", - "name": "processors", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ProcessorContainer", - "namespace": "ingest._types" - } + "name": "ServiceType", + "namespace": "inference.put_googlevertexai" } } }, { - "description": "Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.", - "name": "version", - "required": false, + "description": "Settings used to install the inference model. These settings are specific to the `googlevertexai` service.", + "name": "service_settings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "GoogleVertexAIServiceSettings", + "namespace": "inference.put_googlevertexai" } } }, { - "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.", - "name": "deprecated", + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "name": "task_settings", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "GoogleVertexAITaskSettings", + "namespace": "inference.put_googlevertexai" } } } ] }, - "description": "Create or update a pipeline.\nChanges made using this API take effect immediately.", + "description": "Create a Google Vertex AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googlevertexai` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "examples": { - "PutPipelineRequestExample1": { - "summary": "Create an ingest pipeline.", - "value": "{\n \"description\" : \"My optional pipeline description\",\n \"processors\" : [\n {\n \"set\" : {\n \"description\" : \"My optional processor description\",\n \"field\": \"my-keyword-field\",\n \"value\": \"foo\"\n }\n }\n ]\n}" + "PutGoogleVertexAiRequestExample1": { + "description": "Run `PUT _inference/text_embedding/google_vertex_ai_embeddings` to create an inference endpoint to perform a `text_embedding` task type.", + "summary": "A text embedding task", + "value": "{\n \"service\": \"googlevertexai\",\n \"service_settings\": {\n \"service_account_json\": \"service-account-json\",\n \"model_id\": \"model-id\",\n \"location\": \"location\",\n \"project_id\": \"project-id\"\n }\n}" }, - "PutPipelineRequestExample2": { - "description": "You can use the `_meta` parameter to add arbitrary metadata to a pipeline.", - "summary": "Create an ingest pipeline with metadata.", - "value": "{\n \"description\" : \"My optional pipeline description\",\n \"processors\" : [\n {\n \"set\" : {\n \"description\" : \"My optional processor description\",\n \"field\": \"my-keyword-field\",\n \"value\": \"foo\"\n }\n }\n ],\n \"_meta\": {\n \"reason\": \"set my-keyword-field to foo\",\n \"serialization\": {\n \"class\": \"MyPipeline\",\n \"id\": 10\n }\n }\n}" + "PutGoogleVertexAiRequestExample2": { + "description": "Run `PUT _inference/rerank/google_vertex_ai_rerank` to create an inference endpoint to perform a `rerank` task type.", + "summary": "A rerank task", + "value": "{\n \"service\": \"googlevertexai\",\n \"service_settings\": {\n \"service_account_json\": \"service-account-json\",\n \"project_id\": \"project-id\"\n }\n}" } }, "inherits": { @@ -28125,63 +28357,36 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ingest.put_pipeline" + "namespace": "inference.put_googlevertexai" }, "path": [ { - "description": "ID of the ingest pipeline to create or update.", - "name": "id", + "description": "The type of the inference task that the model will perform.", + "name": "task_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "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": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "Period to wait for a response. If 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" + "name": "GoogleVertexAITaskType", + "namespace": "inference.put_googlevertexai" } } }, { - "description": "Required version for optimistic concurrency control for pipeline updates", - "name": "if_version", - "required": false, + "description": "The unique identifier of the inference endpoint.", + "name": "googlevertexai_inference_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "Id", "namespace": "_types" } } } ], - "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L90" + "query": [], + "specLocation": "inference/put_googlevertexai/PutGoogleVertexAiRequest.ts#L28-L81" }, { "body": { @@ -28189,17 +28394,17 @@ "value": { "kind": "instance_of", "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "name": "InferenceEndpointInfo", + "namespace": "inference._types" } } }, "kind": "response", "name": { "name": "Response", - "namespace": "ingest.put_pipeline" + "namespace": "inference.put_googlevertexai" }, - "specLocation": "ingest/put_pipeline/PutPipelineResponse.ts#L22-L24" + "specLocation": "inference/put_googlevertexai/PutGoogleVertexAiResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -28209,40 +28414,52 @@ "kind": "properties", "properties": [ { - "description": "Sample documents to test in the pipeline.", - "name": "docs", + "description": "The chunking configuration object.", + "extDocId": "inference-chunking", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "name": "chunking_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InferenceChunkingSettings", + "namespace": "inference._types" + } + } + }, + { +>>>>>>> ef980f023 (Add Alibaba Cloud inference API (#4021)) + "description": "The type of service supported for the specified task type. In this case, `hugging_face`.", + "name": "service", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Document", - "namespace": "ingest._types" - } + "kind": "instance_of", + "type": { + "name": "ServiceType", + "namespace": "inference.put_hugging_face" } } }, { - "description": "The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", - "name": "pipeline", - "required": false, + "description": "Settings used to install the inference model. These settings are specific to the `hugging_face` service.", + "name": "service_settings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Pipeline", - "namespace": "ingest._types" + "name": "HuggingFaceServiceSettings", + "namespace": "inference.put_hugging_face" } } } ] }, - "description": "Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", + "description": "Create a Hugging Face inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `hugging_face` service.\n\nYou must first create an inference endpoint on the Hugging Face endpoint page to get an endpoint URL.\nSelect the model you want to use on the new endpoint creation page (for example `intfloat/e5-small-v2`), then select the sentence embeddings task under the advanced configuration section.\nCreate the endpoint and copy the URL after the endpoint initialization has been finished.\n\nThe following models are recommended for the Hugging Face service:\n\n* `all-MiniLM-L6-v2`\n* `all-MiniLM-L12-v2`\n* `all-mpnet-base-v2`\n* `e5-base-v2`\n* `e5-small-v2`\n* `multilingual-e5-base`\n* `multilingual-e5-small`\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "examples": { - "SimulatePipelineRequestExample1": { - "description": "You can specify the used pipeline either in the request body or as a path parameter.", - "summary": "Run an ingest pipeline against a set of provided documents.", - "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}" + "PutHuggingFaceRequestExample1": { + "description": "Run `PUT _inference/text_embedding/hugging-face-embeddings` to create an inference endpoint that performs a `text_embedding` task type.", + "summary": "A text embedding task", + "value": "{\n \"service\": \"hugging_face\",\n \"service_settings\": {\n \"api_key\": \"hugging-face-access-token\", \n \"url\": \"url-endpoint\" \n }\n}" } }, "inherits": { @@ -28254,163 +28471,225 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ingest.simulate" + "namespace": "inference.put_hugging_face" }, "path": [ { - "description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.", - "name": "id", - "required": false, + "description": "The type of the inference task that the model will perform.", + "name": "task_type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "HuggingFaceTaskType", + "namespace": "inference.put_hugging_face" } } - } - ], - "query": [ + }, { - "description": "If `true`, the response includes output data for each processor in the executed pipeline.", - "name": "verbose", - "required": false, + "description": "The unique identifier of the inference endpoint.", + "name": "huggingface_inference_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } } ], - "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L72" + "query": [], + "specLocation": "inference/put_hugging_face/PutHuggingFaceRequest.ts#L27-L89" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "docs", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SimulateDocumentResult", - "namespace": "ingest._types" - } - } - } + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceEndpointInfo", + "namespace": "inference._types" } - ] - }, - "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}" } }, "kind": "response", "name": { "name": "Response", - "namespace": "ingest.simulate" + "namespace": "inference.put_hugging_face" }, - "specLocation": "ingest/simulate/SimulatePipelineResponse.ts#L22-L24" + "specLocation": "inference/put_hugging_face/PutHuggingFaceResponse.ts#L22-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" - }, - "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" + "kind": "properties", + "properties": [ + { + "description": "The chunking configuration object.", + "extDocId": "inference-chunking", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "name": "chunking_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InferenceChunkingSettings", + "namespace": "inference._types" + } + } + }, + { + "description": "The type of service supported for the specified task type. In this case, `openai`.", + "name": "service", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ServiceType", + "namespace": "inference.put_openai" + } + } + }, + { + "description": "Settings used to install the inference model. These settings are specific to the `openai` service.", + "name": "service_settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "OpenAIServiceSettings", + "namespace": "inference.put_openai" + } + } + }, + { + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "name": "task_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "OpenAITaskSettings", + "namespace": "inference.put_openai" + } + } + } + ] + }, + "description": "Create an OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openai` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", + "examples": { + "PutOpenAiRequestExample1": { + "description": "Run `PUT _inference/text_embedding/openai-embeddings` to create an inference endpoint that performs a `text_embedding` task. The embeddings created by requests to this endpoint will have 128 dimensions.", + "summary": "A text embedding task", + "value": "{\n \"service\": \"openai\",\n \"service_settings\": {\n \"api_key\": \"OpenAI-API-Key\",\n \"model_id\": \"text-embedding-3-small\",\n \"dimensions\": 128\n }\n}" + }, + "PutOpenAiRequestExample2": { + "description": "Run `PUT _inference/completion/openai-completion` to create an inference endpoint to perform a completion task type.", + "summary": "A completion task", + "value": "{\n \"service\": \"openai\",\n \"service_settings\": {\n \"api_key\": \"OpenAI-API-Key\",\n \"model_id\": \"gpt-3.5-turbo\"\n }\n}" + } + }, + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } }, "kind": "request", "name": { "name": "Request", - "namespace": "license.get" + "namespace": "inference.put_openai" }, - "path": [], - "query": [ + "path": [ { - "deprecation": { - "description": "", - "version": "7.6.0" - }, - "description": "If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility.\nThis parameter is deprecated and will always be set to true in 8.x.", - "name": "accept_enterprise", - "required": false, - "serverDefault": true, + "description": "The type of the inference task that the model will perform.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.", + "name": "task_type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "OpenAITaskType", + "namespace": "inference.put_openai" } } }, { - "description": "Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node.", - "name": "local", - "required": false, - "serverDefault": false, + "description": "The unique identifier of the inference endpoint.", + "name": "openai_inference_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } } ], - "specLocation": "license/get/GetLicenseRequest.ts#L22-L56" + "query": [], + "specLocation": "inference/put_openai/PutOpenAiRequest.ts#L28-L82" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceEndpointInfo", + "namespace": "inference._types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "inference.put_openai" + }, + "specLocation": "inference/put_openai/PutOpenAiResponse.ts#L22-L24" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], "body": { "kind": "properties", "properties": [ { - "name": "license", + "description": "The type of service supported for the specified task type. In this case, `watsonxai`.", + "name": "service", "required": true, "type": { "kind": "instance_of", "type": { - "name": "LicenseInformation", - "namespace": "license.get" + "name": "ServiceType", + "namespace": "inference.put_watsonx" + } + } + }, + { + "description": "Settings used to install the inference model. These settings are specific to the `watsonxai` service.", + "name": "service_settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "WatsonxServiceSettings", + "namespace": "inference.put_watsonx" } } } ] }, + "description": "Create a Watsonx inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `watsonxai` service.\nYou need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service.\nYou can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "examples": { - "GetLicenseResponseExample1": { - "description": "A successful response from `GET /_license`.", - "value": "{\n \"license\" : {\n \"status\" : \"active\",\n \"uid\" : \"cbff45e7-c553-41f7-ae4f-9205eabd80xx\",\n \"type\" : \"trial\",\n \"issue_date\" : \"2018-10-20T22:05:12.332Z\",\n \"issue_date_in_millis\" : 1540073112332,\n \"expiry_date\" : \"2018-11-19T22:05:12.332Z\",\n \"expiry_date_in_millis\" : 1542665112332,\n \"max_nodes\" : 1000,\n \"max_resource_units\" : null,\n \"issued_to\" : \"test\",\n \"issuer\" : \"elasticsearch\",\n \"start_date_in_millis\" : -1\n }\n}" + "InferenceRequestExample1": { + "description": "Run `PUT _inference/text_embedding/watsonx-embeddings` to create an Watonsx inference endpoint that performs a text embedding task.", + "value": "{\n \"service\": \"watsonxai\",\n \"service_settings\": {\n \"api_key\": \"Watsonx-API-Key\", \n \"url\": \"Wastonx-URL\", \n \"model_id\": \"ibm/slate-30m-english-rtrvr\",\n \"project_id\": \"IBM-Cloud-ID\", \n \"api_version\": \"2024-03-14\"\n }\n}" } }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "license.get" - }, - "specLocation": "license/get/GetLicenseResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Delete a Logstash pipeline.\nDelete a pipeline that is used for Logstash Central Management.\nIf the request succeeds, you receive an empty response with an appropriate status code.", "inherits": { "type": { "name": "RequestBase", @@ -28420,12 +28699,24 @@ "kind": "request", "name": { "name": "Request", - "namespace": "logstash.delete_pipeline" + "namespace": "inference.put_watsonx" }, "path": [ { - "description": "An identifier for the pipeline.", - "name": "id", + "description": "The task type.\nThe only valid task type for the model to perform is `text_embedding`.", + "name": "task_type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "WatsonxTaskType", + "namespace": "inference.put_watsonx" + } + } + }, + { + "description": "The unique identifier of the inference endpoint.", + "name": "watsonx_inference_id", "required": true, "type": { "kind": "instance_of", @@ -28437,27 +28728,94 @@ } ], "query": [], - "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L47" + "specLocation": "inference/put_watsonx/PutWatsonxRequest.ts#L24-L70" }, { "body": { - "kind": "no_body" + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceEndpointInfo", + "namespace": "inference._types" + } + } }, "kind": "response", "name": { "name": "Response", - "namespace": "logstash.delete_pipeline" + "namespace": "inference.put_watsonx" }, - "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineResponse.ts#L22-L24" + "specLocation": "inference/put_watsonx/PutWatsonxResponse.ts#L22-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "kind": "properties", + "properties": [ + { + "description": "Query input.", + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\n> info\n> Inference endpoints for the `completion` task type currently only support a single string as input.", + "name": "input", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.", + "name": "task_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TaskSettings", + "namespace": "inference._types" + } + } + } + ] + }, + "description": "Perform rereanking inference on the service", + "examples": { + "RerankRequestExample1": { + "description": "Run `POST _inference/rerank/cohere_rerank` to perform reranking on the example input.", + "summary": "Rerank task", + "value": "{\n \"input\": [\"luke\", \"like\", \"leia\", \"chewy\",\"r2d2\", \"star\", \"wars\"],\n \"query\": \"star wars main character\"\n}" + } }, - "description": "Get Logstash pipelines.\nGet pipelines that are used for Logstash Central Management.", "inherits": { "type": { "name": "RequestBase", @@ -28467,82 +28825,118 @@ "kind": "request", "name": { "name": "Request", - "namespace": "logstash.get_pipeline" + "namespace": "inference.rerank" }, "path": [ { - "description": "A comma-separated list of pipeline identifiers.", - "name": "id", + "description": "The unique identifier for the inference endpoint.", + "name": "inference_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "The amount of time to wait for the inference request to complete.", + "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "Duration", "namespace": "_types" } } } ], - "query": [], - "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L50" + "specLocation": "inference/rerank/RerankRequest.ts#L25-L72" }, { "body": { - "codegenName": "pipelines", "kind": "value", "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Pipeline", - "namespace": "logstash._types" - } + "kind": "instance_of", + "type": { + "name": "RerankedInferenceResult", + "namespace": "inference._types" } } }, "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}" + "RerankResponseExample1": { + "description": "A successful response from `POST _inference/rerank/cohere_rerank`.\n", + "summary": "Rerank task", + "value": "{\n \"rerank\": [\n {\n \"index\": \"2\",\n \"relevance_score\": \"0.011597361\",\n \"text\": \"leia\"\n },\n {\n \"index\": \"0\",\n \"relevance_score\": \"0.006338922\",\n \"text\": \"luke\"\n },\n {\n \"index\": \"5\",\n \"relevance_score\": \"0.0016166499\",\n \"text\": \"star\"\n },\n {\n \"index\": \"4\",\n \"relevance_score\": \"0.0011695103\",\n \"text\": \"r2d2\"\n },\n {\n \"index\": \"1\",\n \"relevance_score\": \"5.614787E-4\",\n \"text\": \"like\"\n },\n {\n \"index\": \"6\",\n \"relevance_score\": \"3.7850367E-4\",\n \"text\": \"wars\"\n },\n {\n \"index\": \"3\",\n \"relevance_score\": \"1.2508839E-5\",\n \"text\": \"chewy\"\n }\n ]\n}" } }, "kind": "response", "name": { "name": "Response", - "namespace": "logstash.get_pipeline" + "namespace": "inference.rerank" }, - "specLocation": "logstash/get_pipeline/LogstashGetPipelineResponse.ts#L24-L27" + "specLocation": "inference/rerank/RerankResponse.ts#L22-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "codegenName": "pipeline", - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "Pipeline", - "namespace": "logstash._types" + "kind": "properties", + "properties": [ + { + "description": "Inference input.\nEither a string or an array of strings.", + "name": "input", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "Optional task settings", + "name": "task_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TaskSettings", + "namespace": "inference._types" + } + } } - } + ] }, - "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", + "description": "Perform sparse embedding inference on the service", "examples": { - "LogstashPutPipelineRequestExample1": { - "description": "Run `PUT _logstash/pipeline/my_pipeline` to create a pipeline.", - "summary": "Create a pipeline", - "value": "{\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}" + "SparseEmbeddingRequestExample1": { + "description": "Run `POST _inference/sparse_embedding/my-elser-model` to perform sparse embedding on the example sentence.", + "summary": "Sparse embedding task", + "value": "{\n \"input\": \"The sky above the port was the color of television tuned to a dead channel.\"\n}" } }, "inherits": { @@ -28554,12 +28948,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "logstash.put_pipeline" + "namespace": "inference.sparse_embedding" }, "path": [ { - "description": "An identifier for the pipeline.", - "name": "id", + "description": "The inference Id", + "name": "inference_id", "required": true, "type": { "kind": "instance_of", @@ -28570,19 +28964,47 @@ } } ], - "query": [], - "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L51" + "query": [ + { + "description": "Specifies the amount of time to wait for the inference request to complete.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "inference/sparse_embedding/SparseEmbeddingRequest.ts#L25-L63" }, { "body": { - "kind": "no_body" + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "SparseEmbeddingInferenceResult", + "namespace": "inference._types" + } + } + }, + "examples": { + "SparseEmbeddingResponseExample1": { + "description": "An abbreviated response from `POST _inference/sparse_embedding/my-elser-model`.\n", + "summary": "Sparse embedding task", + "value": "{\n \"sparse_embedding\": [\n {\n \"port\": 2.1259406,\n \"sky\": 1.7073475,\n \"color\": 1.6922266,\n \"dead\": 1.6247464,\n \"television\": 1.3525393,\n \"above\": 1.2425821,\n \"tuned\": 1.1440028,\n \"colors\": 1.1218185,\n \"tv\": 1.0111054,\n \"ports\": 1.0067928,\n \"poem\": 1.0042328,\n \"channel\": 0.99471164,\n \"tune\": 0.96235967,\n \"scene\": 0.9020516\n }\n ]\n}" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "logstash.put_pipeline" + "namespace": "inference.sparse_embedding" }, - "specLocation": "logstash/put_pipeline/LogstashPutPipelineResponse.ts#L22-L24" + "specLocation": "inference/sparse_embedding/SparseEmbeddingResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -28592,55 +29014,52 @@ "kind": "properties", "properties": [ { - "description": "The documents you want to retrieve. Required if no index is specified in the request URI.", - "name": "docs", - "required": false, + "description": "Inference input.\nEither a string or an array of strings.", + "name": "input", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Operation", - "namespace": "_global.mget" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - } + ], + "kind": "union_of" } }, { - "description": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", - "name": "ids", + "description": "Optional task settings", + "name": "task_settings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Ids", - "namespace": "_types" + "name": "TaskSettings", + "namespace": "inference._types" } } } ] }, - "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.\n\n**Filter source fields**\n\nBy default, the `_source` field is returned for every document (if stored).\nUse the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document.\nYou can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.\n\n**Get stored fields**\n\nUse the `stored_fields` attribute to specify the set of stored fields you want to retrieve.\nAny requested fields that are not stored are ignored.\nYou can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions.", + "description": "Perform text embedding inference on the service", "examples": { - "MultiGetRequestExample1": { - "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", - "summary": "Get documents by ID", - "value": "{\n \"docs\": [\n {\n \"_id\": \"1\"\n },\n {\n \"_id\": \"2\"\n }\n ]\n}" - }, - "MultiGetRequestExample2": { - "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", - "summary": "Filter source fields", - "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": { - "description": "Run `GET /_mget`. This request retrieves `field1` and `field2` from document 1 and `field3` and `field4` from document 2.\n", - "summary": "Get stored fields", - "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": { - "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", - "summary": "Document routing", - "value": "{\n \"docs\": [\n {\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"routing\": \"key2\"\n },\n {\n \"_index\": \"test\",\n \"_id\": \"2\"\n }\n ]\n}" + "TextEmbeddingRequestExample1": { + "description": "Run `POST _inference/text_embedding/my-cohere-endpoint` to perform text embedding on the example sentence using the Cohere integration,", + "summary": "Text embedding task", + "value": "{\n \"input\": \"The sky above the port was the color of television tuned to a dead channel.\",\n \"task_settings\": {\n \"input_type\": \"ingest\"\n }\n}" } }, "inherits": { @@ -28652,17 +29071,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "_global.mget" + "namespace": "inference.text_embedding" }, "path": [ { - "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.", - "name": "index", - "required": false, + "description": "The inference Id", + "name": "inference_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Id", "namespace": "_types" } } @@ -28670,205 +29089,154 @@ ], "query": [ { - "description": "Specifies the node or shard the operation should be performed on. Random by default.", - "name": "preference", + "description": "Specifies the amount of time to wait for the inference request to complete.", + "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true`, the request is real-time as opposed to near-real-time.", - "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", - "name": "realtime", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true`, the request refreshes relevant shards before retrieving documents.", - "name": "refresh", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Custom value used to route operations to a specific shard.", - "name": "routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Routing", - "namespace": "_types" - } - } - }, - { - "description": "True or false to return the `_source` field or not, or a list of fields to return.", - "name": "_source", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SourceConfigParam", - "namespace": "_global.search._types" - } - } - }, - { - "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.", - "docId": "mapping-source-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", - "name": "_source_excludes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { - "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.", - "docId": "mapping-source-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", - "name": "_source_includes", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { - "description": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.", - "name": "stored_fields", - "required": false, - "serverDefault": "false", - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" + "name": "Duration", + "namespace": "_types" } } } ], - "specLocation": "_global/mget/MultiGetRequest.ts#L25-L127" + "specLocation": "inference/text_embedding/TextEmbeddingRequest.ts#L25-L63" }, { "body": { - "kind": "properties", - "properties": [ - { - "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.", - "name": "docs", - "required": true, - "type": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.mget.Response" - } - } - ], - "kind": "instance_of", - "type": { - "name": "ResponseItem", - "namespace": "_global.mget" - } - } - } + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "TextEmbeddingInferenceResult", + "namespace": "inference._types" } - ] + } }, - "generics": [ - { - "name": "TDocument", - "namespace": "_global.mget.Response" + "examples": { + "TextEmbeddingResponseExample1": { + "description": "An abbreviated response from `POST _inference/text_embedding/my-cohere-endpoint`.\n", + "summary": "Text embedding task", + "value": "{\n \"text_embedding\": [\n {\n \"embedding\": [\n {\n 0.018569946,\n -0.036895752,\n 0.01486969,\n -0.0045204163,\n -0.04385376,\n 0.0075950623,\n 0.04260254,\n -0.004005432,\n 0.007865906,\n 0.030792236,\n -0.050476074,\n 0.011795044,\n -0.011642456,\n -0.010070801\n }\n ]\n }\n ]\n}" } - ], + }, "kind": "response", "name": { "name": "Response", - "namespace": "_global.mget" + "namespace": "inference.text_embedding" }, - "specLocation": "_global/mget/MultiGetResponse.ts#L22-L31" + "specLocation": "inference/text_embedding/TextEmbeddingResponse.ts#L22-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], + "body": { + "kind": "no_body" + }, + "description": "Get cluster info.\nGet basic build, version, and cluster information.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "_global.info" + }, + "path": [], + "query": [], + "specLocation": "_global/info/RootNodeInfoRequest.ts#L22-L39" + }, + { "body": { "kind": "properties", "properties": [ { - "description": "Refer to the description for the `allow_no_match` query parameter.", - "name": "allow_no_match", - "required": false, - "serverDefault": true, + "description": "The responding cluster's name.", + "name": "cluster_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "description": "Refer to the descriptiion for the `force` query parameter.", - "name": "force", - "required": false, - "serverDefault": false, + "name": "cluster_uuid", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "Uuid", + "namespace": "_types" + } + } + }, + { + "description": "The responding node's name.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "tagline", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", "namespace": "_builtins" } } }, { - "description": "Refer to the description for the `timeout` query parameter.", - "name": "timeout", - "required": false, - "serverDefault": "30m", + "description": "The running version of Elasticsearch.", + "name": "version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "ElasticsearchVersionInfo", "namespace": "_types" } } } ] }, - "description": "Close anomaly detection jobs.\n\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", + "examples": { + "RootNodeInfoResponseExample1": { + "description": "A successful response from `GET /`s.", + "value": "{\n \"name\": \"instance-0000000000\",\n \"cluster_name\": \"my_test_cluster\",\n \"cluster_uuid\": \"5QaxoN0pRZuOmWSxstBBwQ\",\n \"version\": {\n \"build_date\": \"2024-02-01T13:07:13.727175297Z\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"build_hash\": \"6185ba65d27469afabc9bc951cded6c17c21e3f3\",\n \"number\": \"8.12.1\",\n \"lucene_version\": \"9.9.2\",\n \"minimum_index_compatibility_version\": \"7.0.0\",\n \"build_flavor\": \"default\",\n \"build_snapshot\": false,\n \"build_type\": \"docker\"\n },\n \"tagline\": \"You Know, for Search\"\n}" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "_global.info" + }, + "specLocation": "_global/info/RootNodeInfoResponse.ts#L23-L40" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Delete pipelines.\nDelete one or more ingest pipelines.", "inherits": { "type": { "name": "RequestBase", @@ -28878,12 +29246,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.close_job" + "namespace": "ingest.delete_pipeline" }, "path": [ { - "description": "Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier.", - "name": "job_id", + "description": "Pipeline ID or wildcard expression of pipeline IDs used to limit the request.\nTo delete all ingest pipelines in a cluster, use a value of `*`.", + "name": "id", "required": true, "type": { "kind": "instance_of", @@ -28896,36 +29264,23 @@ ], "query": [ { - "description": "Specifies what to do when the request: contains wildcard expressions and there are no jobs that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty jobs 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.", - "name": "allow_no_match", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots.\nIf you want the job to be in a consistent state after the close job API returns, do not set to `true`. This parameter should be used only in situations where the job has already failed or where you are not interested in results the job might have recently produced or might produce in the future.", - "name": "force", + "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.", + "name": "master_timeout", "required": false, - "serverDefault": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "description": "Controls the time to wait until a job has closed.", + "description": "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": "30m", + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -28935,37 +29290,25 @@ } } ], - "specLocation": "ml/close_job/MlCloseJobRequest.ts#L24-L85" + "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L61" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "closed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } - ] - }, - "examples": { - "MlCloseJobResponseExample1": { - "description": "A successful response when closing anomaly detection jobs.", - "value": "{\n \"closed\": true\n}" } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.close_job" + "namespace": "ingest.delete_pipeline" }, - "specLocation": "ml/close_job/MlCloseJobResponse.ts#L20-L22" + "specLocation": "ingest/delete_pipeline/DeletePipelineResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -28974,7 +29317,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a calendar.\n\nRemove all scheduled events from a calendar, then delete it.", + "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -28984,13 +29327,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.delete_calendar" + "namespace": "ingest.get_pipeline" }, "path": [ { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_id", - "required": true, + "description": "Comma-separated list of pipeline IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all ingest pipelines, omit this parameter or use `*`.", + "name": "id", + "required": false, "type": { "kind": "instance_of", "type": { @@ -29000,104 +29343,71 @@ } } ], - "query": [], - "specLocation": "ml/delete_calendar/MlDeleteCalendarRequest.ts#L23-L45" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "examples": { - "MlDeleteCalendarResponseExample1": { - "description": "A successful response when deleting a calendar.", - "value": "{\n \"acknowledged\": true\n}" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.delete_calendar" - }, - "specLocation": "ml/delete_calendar/MlDeleteCalendarResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Delete events from a calendar.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.delete_calendar_event" - }, - "path": [ + "query": [ { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_id", - "required": true, + "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.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Duration", "namespace": "_types" } } }, { - "description": "Identifier for the scheduled event.\nYou can obtain this identifier by using the get calendar events API.", - "name": "event_id", - "required": true, + "description": "Return pipelines without their definitions (default: false)", + "name": "summary", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "query": [], - "specLocation": "ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts#L23-L49" + "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L64" }, { "body": { + "codegenName": "pipelines", "kind": "value", "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Pipeline", + "namespace": "ingest._types" + } } } }, "examples": { - "MlDeleteCalendarEventResponseExample1": { - "description": "A successful response when deleting a calendar event.", - "value": "{\n \"acknowledged\": true\n}" + "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 }\n}" } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.delete_calendar_event" + "namespace": "ingest.get_pipeline" }, - "specLocation": "ml/delete_calendar_event/MlDeleteCalendarEventResponse.ts#L22-L24" + "specLocation": "ingest/get_pipeline/GetPipelineResponse.ts#L23-L26" }, { "attachedBehaviors": [ @@ -29106,7 +29416,7 @@ "body": { "kind": "no_body" }, - "description": "Delete anomaly jobs from a calendar.", + "description": "Run a grok processor.\nExtract structured fields out of a single text field within a document.\nYou must 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.", "inherits": { "type": { "name": "RequestBase", @@ -29116,55 +29426,68 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.delete_calendar_job" + "namespace": "ingest.processor_grok" }, - "path": [ - { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a\ncomma-separated list of jobs or groups.", - "name": "job_id", - "required": true, - "type": { - "kind": "instance_of", + "path": [], + "query": [], + "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L40" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "patterns", + "required": true, "type": { - "name": "Ids", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } } - } - ], - "query": [], - "specLocation": "ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts#L23-L50" + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ingest.processor_grok" + }, + "specLocation": "ingest/processor_grok/GrokProcessorPatternsResponse.ts#L22-L24" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], "body": { "kind": "properties", "properties": [ { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_id", - "required": true, + "description": "Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.", + "name": "_meta", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Metadata", "namespace": "_types" } } }, { - "description": "A description of the calendar.", + "description": "Description of the ingest pipeline.", "name": "description", "required": false, "type": { @@ -29176,40 +29499,74 @@ } }, { - "description": "A list of anomaly detection job identifiers or group names.", - "name": "job_ids", - "required": true, + "description": "Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.", + "name": "on_failure", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Ids", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ProcessorContainer", + "namespace": "ingest._types" + } } } - } - ] - }, - "examples": { - "MlDeleteCalendarJobResponseExample1": { - "description": "A successful response when deleting an anomaly detection job from a calendar.", - "value": "{\n \"calendar_id\": \"planned-outages\",\n \"job_ids\": []\n}" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.delete_calendar_job" + }, + { + "description": "Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.", + "name": "processors", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ProcessorContainer", + "namespace": "ingest._types" + } + } + } + }, + { + "description": "Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.", + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "deprecated", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ] }, - "specLocation": "ml/delete_calendar_job/MlDeleteCalendarJobResponse.ts#L22-L31" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" + "description": "Create or update a pipeline.\nChanges made using this API take effect immediately.", + "examples": { + "PutPipelineRequestExample1": { + "summary": "Create an ingest pipeline.", + "value": "{\n \"description\" : \"My optional pipeline description\",\n \"processors\" : [\n {\n \"set\" : {\n \"description\" : \"My optional processor description\",\n \"field\": \"my-keyword-field\",\n \"value\": \"foo\"\n }\n }\n ]\n}" + }, + "PutPipelineRequestExample2": { + "description": "You can use the `_meta` parameter to add arbitrary metadata to a pipeline.", + "summary": "Create an ingest pipeline with metadata.", + "value": "{\n \"description\" : \"My optional pipeline description\",\n \"processors\" : [\n {\n \"set\" : {\n \"description\" : \"My optional processor description\",\n \"field\": \"my-keyword-field\",\n \"value\": \"foo\"\n }\n }\n ],\n \"_meta\": {\n \"reason\": \"set my-keyword-field to foo\",\n \"serialization\": {\n \"class\": \"MyPipeline\",\n \"id\": 10\n }\n }\n}" + } }, - "description": "Delete a data frame analytics job.", "inherits": { "type": { "name": "RequestBase", @@ -29219,11 +29576,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.delete_data_frame_analytics" + "namespace": "ingest.put_pipeline" }, "path": [ { - "description": "Identifier for the data frame analytics job.", + "description": "ID of the ingest pipeline to create or update.", "name": "id", "required": true, "type": { @@ -29237,23 +29594,23 @@ ], "query": [ { - "description": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.", - "name": "force", + "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": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "description": "The time to wait for the job to be deleted.", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, - "serverDefault": "1m", + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -29261,9 +29618,21 @@ "namespace": "_types" } } + }, + { + "description": "Required version for optimistic concurrency control for pipeline updates", + "name": "if_version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } } ], - "specLocation": "ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts#L24-L58" + "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L90" }, { "body": { @@ -29276,27 +29645,57 @@ } } }, - "examples": { - "MlDeleteDataFrameAnalyticsResponseExample1": { - "description": "A successful response when deleting a data frame analytics job.", - "value": "{\n \"acknowledged\": true\n}" - } - }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.delete_data_frame_analytics" + "namespace": "ingest.put_pipeline" }, - "specLocation": "ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsResponse.ts#L22-L24" + "specLocation": "ingest/put_pipeline/PutPipelineResponse.ts#L22-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "kind": "properties", + "properties": [ + { + "description": "Sample documents to test in the pipeline.", + "name": "docs", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Document", + "namespace": "ingest._types" + } + } + } + }, + { + "description": "The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", + "name": "pipeline", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Pipeline", + "namespace": "ingest._types" + } + } + } + ] + }, + "description": "Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", + "examples": { + "SimulatePipelineRequestExample1": { + "description": "You can specify the used pipeline either in the request body or as a path parameter.", + "summary": "Run an ingest pipeline against a set of provided documents.", + "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}" + } }, - "description": "Delete a datafeed.", "inherits": { "type": { "name": "RequestBase", @@ -29306,13 +29705,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.delete_datafeed" + "namespace": "ingest.simulate" }, "path": [ { - "description": "A numerical character string that uniquely identifies the datafeed. This\nidentifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It must start and end with alphanumeric\ncharacters.", - "name": "datafeed_id", - "required": true, + "description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.", + "name": "id", + "required": false, "type": { "kind": "instance_of", "type": { @@ -29324,8 +29723,8 @@ ], "query": [ { - "description": "Use to forcefully delete a started datafeed; this method is quicker than\nstopping and deleting the datafeed.", - "name": "force", + "description": "If `true`, the response includes output data for each processor in the executed pipeline.", + "name": "verbose", "required": false, "type": { "kind": "instance_of", @@ -29336,31 +29735,40 @@ } } ], - "specLocation": "ml/delete_datafeed/MlDeleteDatafeedRequest.ts#L23-L55" + "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L72" }, { "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "kind": "properties", + "properties": [ + { + "name": "docs", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SimulateDocumentResult", + "namespace": "ingest._types" + } + } + } } - } + ] }, "examples": { - "MlDeleteDatafeedResponseExample1": { - "description": "A successful response when deleting a datafeed.", - "value": "{\n \"acknowledged\": true\n}" + "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}" } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.delete_datafeed" + "namespace": "ingest.simulate" }, - "specLocation": "ml/delete_datafeed/MlDeleteDatafeedResponse.ts#L22-L24" + "specLocation": "ingest/simulate/SimulatePipelineResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -29369,7 +29777,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a filter.\n\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", + "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "inherits": { "type": { "name": "RequestBase", @@ -29379,48 +29787,72 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.delete_filter" + "namespace": "license.get" }, - "path": [ + "path": [], + "query": [ { - "description": "A string that uniquely identifies a filter.", - "name": "filter_id", - "required": true, + "deprecation": { + "description": "", + "version": "7.6.0" + }, + "description": "If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility.\nThis parameter is deprecated and will always be set to true in 8.x.", + "name": "accept_enterprise", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node.", + "name": "local", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } ], - "query": [], - "specLocation": "ml/delete_filter/MlDeleteFilterRequest.ts#L23-L48" + "specLocation": "license/get/GetLicenseRequest.ts#L22-L56" }, { "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "kind": "properties", + "properties": [ + { + "name": "license", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "LicenseInformation", + "namespace": "license.get" + } + } } - } + ] }, "examples": { - "MlDeleteFilterResponseExample1": { - "description": "A successful response when deleting a filter.", - "value": "{\n \"acknowledged\": true\n}" + "GetLicenseResponseExample1": { + "description": "A successful response from `GET /_license`.", + "value": "{\n \"license\" : {\n \"status\" : \"active\",\n \"uid\" : \"cbff45e7-c553-41f7-ae4f-9205eabd80xx\",\n \"type\" : \"trial\",\n \"issue_date\" : \"2018-10-20T22:05:12.332Z\",\n \"issue_date_in_millis\" : 1540073112332,\n \"expiry_date\" : \"2018-11-19T22:05:12.332Z\",\n \"expiry_date_in_millis\" : 1542665112332,\n \"max_nodes\" : 1000,\n \"max_resource_units\" : null,\n \"issued_to\" : \"test\",\n \"issuer\" : \"elasticsearch\",\n \"start_date_in_millis\" : -1\n }\n}" } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.delete_filter" + "namespace": "license.get" }, - "specLocation": "ml/delete_filter/MlDeleteFilterResponse.ts#L22-L24" + "specLocation": "license/get/GetLicenseResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -29429,7 +29861,7 @@ "body": { "kind": "no_body" }, - "description": "Delete an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", + "description": "Delete a Logstash pipeline.\nDelete a pipeline that is used for Logstash Central Management.\nIf the request succeeds, you receive an empty response with an appropriate status code.", "inherits": { "type": { "name": "RequestBase", @@ -29439,12 +29871,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.delete_job" + "namespace": "logstash.delete_pipeline" }, "path": [ { - "description": "Identifier for the anomaly detection job.", - "name": "job_id", + "description": "An identifier for the pipeline.", + "name": "id", "required": true, "type": { "kind": "instance_of", @@ -29455,77 +29887,19 @@ } } ], - "query": [ - { - "description": "Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.", - "name": "force", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "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.", - "name": "delete_user_annotations", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Specifies whether the request should return immediately or wait until the\njob deletion completes.", - "name": "wait_for_completion", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L72" + "query": [], + "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L47" }, { "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "examples": { - "MlDeleteJobResponseExample1": { - "description": "A successful response when deleting an anomaly detection job.", - "summary": "Delete job", - "value": "{\n \"acknowledged\": true\n}" - }, - "MlDeleteJobResponseExample2": { - "description": "A successful response when deleting an anomaly detection job asynchronously. When the `wait_for_completion` query parameter is set to `false`, the response contains an identifier for the job deletion task.\n", - "summary": "Delete job asynchronously", - "value": "{\n \"task\": \"oTUltX4IQMOUUVeiohTt8A:39\"\n}" - } + "kind": "no_body" }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.delete_job" + "namespace": "logstash.delete_pipeline" }, - "specLocation": "ml/delete_job/MlDeleteJobResponse.ts#L22-L24" + "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -29534,7 +29908,7 @@ "body": { "kind": "no_body" }, - "description": "Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", + "description": "Get Logstash pipelines.\nGet pipelines that are used for Logstash Central Management.", "inherits": { "type": { "name": "RequestBase", @@ -29544,83 +29918,84 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.delete_trained_model" + "namespace": "logstash.get_pipeline" }, "path": [ { - "description": "The unique identifier of the trained model.", - "name": "model_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.", - "name": "force", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", + "description": "A comma-separated list of pipeline identifiers.", + "name": "id", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "Ids", "namespace": "_types" } } } ], - "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelRequest.ts#L24-L57" + "query": [], + "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L50" }, { "body": { + "codegenName": "pipelines", "kind": "value", "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Pipeline", + "namespace": "logstash._types" + } } } }, "examples": { - "MlDeleteTrainedModelResponseExample1": { - "description": "A successful response when deleting an existing trained inference model.", - "value": "{\n \"acknowledged\": true\n}" + "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}" } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.delete_trained_model" + "namespace": "logstash.get_pipeline" }, - "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelResponse.ts#L22-L24" + "specLocation": "logstash/get_pipeline/LogstashGetPipelineResponse.ts#L24-L27" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "codegenName": "pipeline", + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "Pipeline", + "namespace": "logstash._types" + } + } + }, + "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", + "examples": { + "LogstashPutPipelineRequestExample1": { + "description": "Run `PUT _logstash/pipeline/my_pipeline` to create a pipeline.", + "summary": "Create a pipeline", + "value": "{\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}" + } }, - "description": "Delete a trained model alias.\n\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "inherits": { "type": { "name": "RequestBase", @@ -29630,24 +30005,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.delete_trained_model_alias" + "namespace": "logstash.put_pipeline" }, "path": [ { - "description": "The model alias to delete.", - "name": "model_alias", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "description": "The trained model ID to which the model alias refers.", - "name": "model_id", + "description": "An identifier for the pipeline.", + "name": "id", "required": true, "type": { "kind": "instance_of", @@ -29659,31 +30022,18 @@ } ], "query": [], - "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts#L23-L53" + "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L51" }, { "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "examples": { - "MlDeleteTrainedModelAliasResponseExample1": { - "description": "A successful response when deleting a trained model alias.", - "value": "{\n \"acknowledged\": true\n}" - } + "kind": "no_body" }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.delete_trained_model_alias" + "namespace": "logstash.put_pipeline" }, - "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasResponse.ts#L22-L24" + "specLocation": "logstash/put_pipeline/LogstashPutPipelineResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -29693,70 +30043,55 @@ "kind": "properties", "properties": [ { - "description": "For a list of the properties that you can specify in the\n`analysis_config` component of the body of this API.", - "name": "analysis_config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "AnalysisConfig", - "namespace": "ml._types" - } - } - }, - { - "description": "Estimates of the highest cardinality in a single bucket that is observed\nfor influencer fields over the time period that the job analyzes data.\nTo produce a good answer, values must be provided for all influencer\nfields. Providing values for fields that are not listed as `influencers`\nhas no effect on the estimation.", - "name": "max_bucket_cardinality", + "description": "The documents you want to retrieve. Required if no index is specified in the request URI.", + "name": "docs", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "Operation", + "namespace": "_global.mget" } } } }, { - "description": "Estimates of the cardinality that is observed for fields over the whole\ntime period that the job analyzes data. To produce a good answer, values\nmust be provided for fields referenced in the `by_field_name`,\n`over_field_name` and `partition_field_name` of any detectors. Providing\nvalues for other fields has no effect on the estimation. It can be\nomitted from the request if no detectors have a `by_field_name`,\n`over_field_name` or `partition_field_name`.", - "name": "overall_cardinality", + "description": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", + "name": "ids", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "Ids", + "namespace": "_types" } } } ] }, - "description": "Estimate job model memory usage.\n\nMake an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.\n\n**Filter source fields**\n\nBy default, the `_source` field is returned for every document (if stored).\nUse the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document.\nYou can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.\n\n**Get stored fields**\n\nUse the `stored_fields` attribute to specify the set of stored fields you want to retrieve.\nAny requested fields that are not stored are ignored.\nYou can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions.", "examples": { - "MlEstimateModelMemoryRequestExample1": { - "description": "Run `POST _ml/anomaly_detectors/_estimate_model_memory` to estimate the model memory limit based on the analysis configuration details provided in the request body.", - "value": "{\n \"analysis_config\": {\n \"bucket_span\": \"5m\",\n \"detectors\": [\n {\n \"function\": \"sum\",\n \"field_name\": \"bytes\",\n \"by_field_name\": \"status\",\n \"partition_field_name\": \"app\"\n }\n ],\n \"influencers\": [\n \"source_ip\",\n \"dest_ip\"\n ]\n },\n \"overall_cardinality\": {\n \"status\": 10,\n \"app\": 50\n },\n \"max_bucket_cardinality\": {\n \"source_ip\": 300,\n \"dest_ip\": 30\n }\n}" + "MultiGetRequestExample1": { + "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", + "summary": "Get documents by ID", + "value": "{\n \"docs\": [\n {\n \"_id\": \"1\"\n },\n {\n \"_id\": \"2\"\n }\n ]\n}" + }, + "MultiGetRequestExample2": { + "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", + "summary": "Filter source fields", + "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": { + "description": "Run `GET /_mget`. This request retrieves `field1` and `field2` from document 1 and `field3` and `field4` from document 2.\n", + "summary": "Get stored fields", + "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": { + "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", + "summary": "Document routing", + "value": "{\n \"docs\": [\n {\n \"_index\": \"test\",\n \"_id\": \"1\",\n \"routing\": \"key2\"\n },\n {\n \"_index\": \"test\",\n \"_id\": \"2\"\n }\n ]\n}" } }, "inherits": { @@ -29768,197 +30103,173 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.estimate_model_memory" + "namespace": "_global.mget" }, - "path": [], - "query": [], - "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L71" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "model_memory_estimate", - "required": true, + "path": [ + { + "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.", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "IndexName", + "namespace": "_types" } } - ] - }, - "examples": { - "MlEstimateModelMemoryResponseExample1": { - "description": "A successful response from `POST _ml/anomaly_detectors/_estimate_model_memory`.", - "value": "{\n \"model_memory_estimate\": \"21mb\"\n}" } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.estimate_model_memory" - }, - "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryResponse.ts#L20-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "Defines the type of evaluation you want to perform.", - "name": "evaluation", - "required": true, + "query": [ + { + "description": "Specifies the node or shard the operation should be performed on. Random by default.", + "name": "preference", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "DataframeEvaluationContainer", - "namespace": "ml._types" - } + "name": "string", + "namespace": "_builtins" } - }, - { - "description": "Defines the `index` in which the evaluation will be performed.", - "name": "index", - "required": true, + } + }, + { + "description": "If `true`, the request is real-time as opposed to near-real-time.", + "docId": "realtime", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "name": "realtime", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "description": "A query clause that retrieves a subset of data from the source index.", - "docId": "query-dsl", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", - "name": "query", - "required": false, + } + }, + { + "description": "If `true`, the request refreshes relevant shards before retrieving documents.", + "name": "refresh", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } + "name": "boolean", + "namespace": "_builtins" } } - ] - }, - "description": "Evaluate data frame analytics.\n\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", - "examples": { - "MlEvaluateDataFrameRequestExample1": { - "description": "Run `POST _ml/data_frame/_evaluate` to evaluate a a classification job for an annotated index. The `actual_field` contains the ground truth for classification. The `predicted_field` contains the predicted value calculated by the classification analysis.\n", - "summary": "Classification example 1", - "value": "{\n \"index\": \"animal_classification\",\n \"evaluation\": {\n \"classification\": {\n \"actual_field\": \"animal_class\",\n \"predicted_field\": \"ml.animal_class_prediction\",\n \"metrics\": {\n \"multiclass_confusion_matrix\": {}\n }\n }\n }\n}" }, - "MlEvaluateDataFrameRequestExample2": { - "description": "Run `POST _ml/data_frame/_evaluate` to evaluate a classification job with AUC ROC metrics for an annotated index. The `actual_field` contains the ground truth value for the actual animal classification. This is required in order to evaluate results. The `class_name` specifies the class name that is treated as positive during the evaluation, all the other classes are treated as negative.\n", - "summary": "Classification example 2", - "value": "{\n \"index\": \"animal_classification\",\n \"evaluation\": {\n \"classification\": {\n \"actual_field\": \"animal_class\",\n \"metrics\": {\n \"auc_roc\": {\n \"class_name\": \"dog\"\n }\n }\n }\n }\n}" + { + "description": "Custom value used to route operations to a specific shard.", + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" + } + } }, - "MlEvaluateDataFrameRequestExample3": { - "description": "Run `POST _ml/data_frame/_evaluate` to evaluate an outlier detection job for an annotated index.\n", - "summary": "Outlier detection", - "value": "{\n \"index\": \"my_analytics_dest_index\",\n \"evaluation\": {\n \"outlier_detection\": {\n \"actual_field\": \"is_outlier\",\n \"predicted_probability_field\": \"ml.outlier_score\"\n }\n }\n}" + { + "description": "True or false to return the `_source` field or not, or a list of fields to return.", + "name": "_source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SourceConfigParam", + "namespace": "_global.search._types" + } + } }, - "MlEvaluateDataFrameRequestExample4": { - "description": "Run `POST _ml/data_frame/_evaluate` to evaluate the testing error of a regression job for an annotated index. The term query in the body limits evaluation to be performed on the test split only. The `actual_field` contains the ground truth for house prices. The `predicted_field` contains the house price calculated by the regression analysis.\n", - "summary": "Regression example 1", - "value": "{\n \"index\": \"house_price_predictions\",\n \"query\": {\n \"bool\": {\n \"filter\": [\n {\n \"term\": {\n \"ml.is_training\": false\n }\n }\n ]\n }\n },\n \"evaluation\": {\n \"regression\": {\n \"actual_field\": \"price\",\n \"predicted_field\": \"ml.price_prediction\",\n \"metrics\": {\n \"r_squared\": {},\n \"mse\": {},\n \"msle\": {\n \"offset\": 10\n },\n \"huber\": {\n \"delta\": 1.5\n }\n }\n }\n }\n}" + { + "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.", + "docId": "mapping-source-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "name": "_source_excludes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } }, - "MlEvaluateDataFrameRequestExample5": { - "description": "Run `POST _ml/data_frame/_evaluate` to evaluate the training error of a regression job for an annotated index. The term query in the body limits evaluation to be performed on the training split only. The `actual_field` contains the ground truth for house prices. The `predicted_field` contains the house price calculated by the regression analysis.\n", - "summary": "Regression example 2", - "value": "{\n \"index\": \"house_price_predictions\",\n \"query\": {\n \"term\": {\n \"ml.is_training\": {\n \"value\": true\n }\n }\n },\n \"evaluation\": {\n \"regression\": {\n \"actual_field\": \"price\",\n \"predicted_field\": \"ml.price_prediction\",\n \"metrics\": {\n \"r_squared\": {},\n \"mse\": {},\n \"msle\": {},\n \"huber\": {}\n }\n }\n }\n}" - } - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" + { + "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.", + "docId": "mapping-source-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "name": "_source_includes", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.", + "name": "stored_fields", + "required": false, + "serverDefault": "false", + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.evaluate_data_frame" - }, - "path": [], - "query": [], - "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts#L25-L61" + ], + "specLocation": "_global/mget/MultiGetRequest.ts#L25-L127" }, { "body": { "kind": "properties", "properties": [ { - "description": "Evaluation results for a classification analysis.\nIt outputs a prediction that identifies to which of the classes each document belongs.", - "name": "classification", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeClassificationSummary", - "namespace": "ml.evaluate_data_frame" - } - } - }, - { - "description": "Evaluation results for an outlier detection analysis.\nIt outputs the probability that each document is an outlier.", - "name": "outlier_detection", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeOutlierDetectionSummary", - "namespace": "ml.evaluate_data_frame" - } - } - }, - { - "description": "Evaluation results for a regression analysis which outputs a prediction of values.", - "name": "regression", - "required": false, + "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.", + "name": "docs", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "DataframeRegressionSummary", - "namespace": "ml.evaluate_data_frame" + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.mget.Response" + } + } + ], + "kind": "instance_of", + "type": { + "name": "ResponseItem", + "namespace": "_global.mget" + } } } } ] }, - "examples": { - "MlEvaluateDataFrameResponseExample1": { - "description": "A succesful response from `POST _ml/data_frame/_evaluate` to evaluate a classification analysis job for an annotated index. The `actual_class` contains the name of the class the analysis tried to predict. The `actual_class_doc_count` is the number of documents in the index belonging to the `actual_class`. The `predicted_classes` object contains the list of the predicted classes and the number of predictions associated with the class.\n", - "summary": "Classification example 1", - "value": "{\n \"classification\": {\n \"multiclass_confusion_matrix\": {\n \"confusion_matrix\": [\n {\n \"actual_class\": \"cat\",\n \"actual_class_doc_count\": 12,\n \"predicted_classes\": [\n {\n \"predicted_class\": \"cat\",\n \"count\": 12\n },\n {\n \"predicted_class\": \"dog\",\n \"count\": 0\n }\n ],\n \"other_predicted_class_doc_count\": 0\n },\n {\n \"actual_class\": \"dog\",\n \"actual_class_doc_count\": 11,\n \"predicted_classes\": [\n {\n \"predicted_class\": \"dog\",\n \"count\": 7\n },\n {\n \"predicted_class\": \"cat\",\n \"count\": 4\n }\n ],\n \"other_predicted_class_doc_count\": 0\n }\n ],\n \"other_actual_class_count\": 0\n }\n }\n}" - }, - "MlEvaluateDataFrameResponseExample2": { - "description": "A succesful response from `POST _ml/data_frame/_evaluate` to evaluate a classification analysis job with the AUC ROC metrics for an annotated index.\n", - "summary": "Classification example 2", - "value": "{\n \"classification\": {\n \"auc_roc\": {\n \"value\": 0.8941788639536681\n }\n }\n}" - }, - "MlEvaluateDataFrameResponseExample3": { - "description": "A successful response from `POST _ml/data_frame/_evaluate` to evaluate an outlier detection job.", - "summary": "Outlier detection", - "value": "{\n \"outlier_detection\": {\n \"auc_roc\": {\n \"value\": 0.9258475774641445\n },\n \"confusion_matrix\": {\n \"0.25\": {\n \"tp\": 5,\n \"fp\": 9,\n \"tn\": 204,\n \"fn\": 5\n },\n \"0.5\": {\n \"tp\": 1,\n \"fp\": 5,\n \"tn\": 208,\n \"fn\": 9\n },\n \"0.75\": {\n \"tp\": 0,\n \"fp\": 4,\n \"tn\": 209,\n \"fn\": 10\n }\n },\n \"precision\": {\n \"0.25\": 0.35714285714285715,\n \"0.5\": 0.16666666666666666,\n \"0.75\": 0\n },\n \"recall\": {\n \"0.25\": 0.5,\n \"0.5\": 0.1,\n \"0.75\": 0\n }\n }\n}" + "generics": [ + { + "name": "TDocument", + "namespace": "_global.mget.Response" } - }, + ], "kind": "response", "name": { "name": "Response", - "namespace": "ml.evaluate_data_frame" + "namespace": "_global.mget" }, - "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameResponse.ts#L26-L44" + "specLocation": "_global/mget/MultiGetResponse.ts#L22-L31" }, { "attachedBehaviors": [ @@ -29968,21 +30279,10 @@ "kind": "properties", "properties": [ { - "description": "Refer to the description for the `advance_time` query parameter.", - "name": "advance_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } - }, - { - "description": "Refer to the description for the `calc_interim` query parameter.", - "name": "calc_interim", + "description": "Refer to the description for the `allow_no_match` query parameter.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -29992,44 +30292,34 @@ } }, { - "description": "Refer to the description for the `end` query parameter.", - "name": "end", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } - }, - { - "description": "Refer to the description for the `skip_time` query parameter.", - "name": "skip_time", + "description": "Refer to the descriptiion for the `force` query parameter.", + "name": "force", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Refer to the description for the `start` query parameter.", - "name": "start", + "description": "Refer to the description for the `timeout` query parameter.", + "name": "timeout", "required": false, + "serverDefault": "30m", "type": { "kind": "instance_of", "type": { - "name": "DateTime", + "name": "Duration", "namespace": "_types" } } } ] }, - "description": "Force buffered data to be processed.\nThe flush jobs API is only applicable when sending data for analysis using\nthe post data API. Depending on the content of the buffer, then it might\nadditionally calculate new results. Both flush and close operations are\nsimilar, however the flush is more efficient if you are expecting to send\nmore data for analysis. When flushing, the job remains open and is available\nto continue analyzing data. A close operation additionally prunes and\npersists the model state to disk and the job must be opened again before\nanalyzing further data.", + "description": "Close anomaly detection jobs.\n\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", "inherits": { "type": { "name": "RequestBase", @@ -30039,11 +30329,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.flush_job" + "namespace": "ml.close_job" }, "path": [ { - "description": "Identifier for the anomaly detection job.", + "description": "Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier.", "name": "job_id", "required": true, "type": { @@ -30057,21 +30347,10 @@ ], "query": [ { - "description": "Specifies to advance to a particular time value. Results are generated\nand the model is updated for data from the specified time interval.", - "name": "advance_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } - }, - { - "description": "If true, calculates the interim results for the most recent bucket or all\nbuckets within the latency period.", - "name": "calc_interim", + "description": "Specifies what to do when the request: contains wildcard expressions and there are no jobs that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty jobs 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.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -30081,50 +30360,40 @@ } }, { - "description": "When used in conjunction with `calc_interim` and `start`, specifies the\nrange of buckets on which to calculate interim results.", - "name": "end", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } - }, - { - "description": "Specifies to skip to a particular time value. Results are not generated\nand the model is not updated for data from the specified time interval.", - "name": "skip_time", + "description": "Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots.\nIf you want the job to be in a consistent state after the close job API returns, do not set to `true`. This parameter should be used only in situations where the job has already failed or where you are not interested in results the job might have recently produced or might produce in the future.", + "name": "force", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "When used in conjunction with `calc_interim`, specifies the range of\nbuckets on which to calculate interim results.", - "name": "start", + "description": "Controls the time to wait until a job has closed.", + "name": "timeout", "required": false, + "serverDefault": "30m", "type": { "kind": "instance_of", "type": { - "name": "DateTime", + "name": "Duration", "namespace": "_types" } } } ], - "specLocation": "ml/flush_job/MlFlushJobRequest.ts#L24-L107" + "specLocation": "ml/close_job/MlCloseJobRequest.ts#L24-L85" }, { "body": { "kind": "properties", "properties": [ { - "name": "flushed", + "name": "closed", "required": true, "type": { "kind": "instance_of", @@ -30133,27 +30402,21 @@ "namespace": "_builtins" } } - }, - { - "description": "Provides the timestamp (in milliseconds since the epoch) of the end of\nthe last bucket that was processed.", - "name": "last_finalized_bucket_end", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } } ] }, + "examples": { + "MlCloseJobResponseExample1": { + "description": "A successful response when closing anomaly detection jobs.", + "value": "{\n \"closed\": true\n}" + } + }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.flush_job" + "namespace": "ml.close_job" }, - "specLocation": "ml/flush_job/MlFlushJobResponse.ts#L22-L31" + "specLocation": "ml/close_job/MlCloseJobResponse.ts#L20-L22" }, { "attachedBehaviors": [ @@ -30162,7 +30425,7 @@ "body": { "kind": "no_body" }, - "description": "Get info about events in calendars.", + "description": "Delete a calendar.\n\nRemove all scheduled events from a calendar, then delete it.", "inherits": { "type": { "name": "RequestBase", @@ -30172,11 +30435,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_calendar_events" + "namespace": "ml.delete_calendar" }, "path": [ { - "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.", + "description": "A string that uniquely identifies a calendar.", "name": "calendar_id", "required": true, "type": { @@ -30188,132 +30451,113 @@ } } ], - "query": [ + "query": [], + "specLocation": "ml/delete_calendar/MlDeleteCalendarRequest.ts#L23-L45" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "examples": { + "MlDeleteCalendarResponseExample1": { + "description": "A successful response when deleting a calendar.", + "value": "{\n \"acknowledged\": true\n}" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.delete_calendar" + }, + "specLocation": "ml/delete_calendar/MlDeleteCalendarResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Delete events from a calendar.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.delete_calendar_event" + }, + "path": [ { - "description": "Specifies to get events with timestamps earlier than this time.", - "name": "end", - "required": false, + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateTime", + "name": "Id", "namespace": "_types" } } }, { - "description": "Skips the specified number of events.", - "name": "from", - "required": false, - "serverDefault": 0, + "description": "Identifier for the scheduled event.\nYou can obtain this identifier by using the get calendar events API.", + "name": "event_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`.", - "name": "job_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "Specifies the maximum number of events to obtain.", - "name": "size", - "required": false, - "serverDefault": 100, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Specifies to get events with timestamps after this time.", - "name": "start", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", + "name": "Id", "namespace": "_types" } } } ], - "specLocation": "ml/get_calendar_events/MlGetCalendarEventsRequest.ts#L25-L61" + "query": [], + "specLocation": "ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts#L23-L49" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "events", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CalendarEvent", - "namespace": "ml._types" - } - } - } + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } - ] + } + }, + "examples": { + "MlDeleteCalendarEventResponseExample1": { + "description": "A successful response when deleting a calendar event.", + "value": "{\n \"acknowledged\": true\n}" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_calendar_events" + "namespace": "ml.delete_calendar_event" }, - "specLocation": "ml/get_calendar_events/MlGetCalendarEventsResponse.ts#L23-L28" + "specLocation": "ml/delete_calendar_event/MlDeleteCalendarEventResponse.ts#L22-L24" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "description": "This object is supported only when you omit the calendar identifier.", - "name": "page", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Page", - "namespace": "ml._types" - } - } - } - ] + "kind": "no_body" }, - "description": "Get calendar configuration info.", + "description": "Delete anomaly jobs from a calendar.", "inherits": { "type": { "name": "RequestBase", @@ -30323,13 +30567,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_calendars" + "namespace": "ml.delete_calendar_job" }, "path": [ { - "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.", + "description": "A string that uniquely identifies a calendar.", "name": "calendar_id", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -30337,75 +30581,77 @@ "namespace": "_types" } } - } - ], - "query": [ - { - "description": "Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier.", - "name": "from", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } }, { - "description": "Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier.", - "name": "size", - "required": false, - "serverDefault": 10000, + "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a\ncomma-separated list of jobs or groups.", + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Ids", "namespace": "_types" } } } ], - "specLocation": "ml/get_calendars/MlGetCalendarsRequest.ts#L25-L63" + "query": [], + "specLocation": "ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts#L23-L50" }, { "body": { "kind": "properties", "properties": [ { - "name": "calendars", + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Calendar", - "namespace": "ml.get_calendars" - } + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" } } }, { - "name": "count", + "description": "A description of the calendar.", + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "A list of anomaly detection job identifiers or group names.", + "name": "job_ids", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Ids", "namespace": "_types" } } } ] }, + "examples": { + "MlDeleteCalendarJobResponseExample1": { + "description": "A successful response when deleting an anomaly detection job from a calendar.", + "value": "{\n \"calendar_id\": \"planned-outages\",\n \"job_ids\": []\n}" + } + }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_calendars" + "namespace": "ml.delete_calendar_job" }, - "specLocation": "ml/get_calendars/MlGetCalendarsResponse.ts#L23-L25" + "specLocation": "ml/delete_calendar_job/MlDeleteCalendarJobResponse.ts#L22-L31" }, { "attachedBehaviors": [ @@ -30414,7 +30660,7 @@ "body": { "kind": "no_body" }, - "description": "Get data frame analytics job configuration info.\nYou can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", + "description": "Delete a data frame analytics job.", "inherits": { "type": { "name": "RequestBase", @@ -30424,13 +30670,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_data_frame_analytics" + "namespace": "ml.delete_data_frame_analytics" }, "path": [ { - "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.", + "description": "Identifier for the data frame analytics job.", "name": "id", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -30442,10 +30688,10 @@ ], "query": [ { - "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.", - "name": "allow_no_match", + "description": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.", + "name": "force", "required": false, - "serverDefault": true, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -30455,85 +30701,44 @@ } }, { - "description": "Skips the specified number of data frame analytics jobs.", - "name": "from", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Specifies the maximum number of data frame analytics jobs to obtain.", - "name": "size", + "description": "The time to wait for the job to be deleted.", + "name": "timeout", "required": false, - "serverDefault": 100, + "serverDefault": "1m", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Duration", "namespace": "_types" } } - }, - { - "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.", - "name": "exclude_generated", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } } ], - "specLocation": "ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts#L24-L89" + "specLocation": "ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts#L24-L58" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "An array of data frame analytics job resources, which are sorted by the id value in ascending order.", - "name": "data_frame_analytics", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsSummary", - "namespace": "ml._types" - } - } - } + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } - ] + } + }, + "examples": { + "MlDeleteDataFrameAnalyticsResponseExample1": { + "description": "A successful response when deleting a data frame analytics job.", + "value": "{\n \"acknowledged\": true\n}" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_data_frame_analytics" + "namespace": "ml.delete_data_frame_analytics" }, - "specLocation": "ml/get_data_frame_analytics/MlGetDataFrameAnalyticsResponse.ts#L23-L29" + "specLocation": "ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -30542,7 +30747,7 @@ "body": { "kind": "no_body" }, - "description": "Get data frame analytics jobs usage info.", + "description": "Delete a datafeed.", "inherits": { "type": { "name": "RequestBase", @@ -30552,13 +30757,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_data_frame_analytics_stats" + "namespace": "ml.delete_datafeed" }, "path": [ { - "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.", - "name": "id", - "required": false, + "description": "A numerical character string that uniquely identifies the datafeed. This\nidentifier can contain lowercase alphanumeric characters (a-z and 0-9),\nhyphens, and underscores. It must start and end with alphanumeric\ncharacters.", + "name": "datafeed_id", + "required": true, "type": { "kind": "instance_of", "type": { @@ -30570,49 +30775,9 @@ ], "query": [ { - "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.", - "name": "allow_no_match", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Skips the specified number of data frame analytics jobs.", - "name": "from", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Specifies the maximum number of data frame analytics jobs to obtain.", - "name": "size", - "required": false, - "serverDefault": 100, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Defines whether the stats response should be verbose.", - "name": "verbose", + "description": "Use to forcefully delete a started datafeed; this method is quicker than\nstopping and deleting the datafeed.", + "name": "force", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -30622,46 +30787,31 @@ } } ], - "specLocation": "ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts#L24-L84" + "specLocation": "ml/delete_datafeed/MlDeleteDatafeedRequest.ts#L23-L55" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order.", - "name": "data_frame_analytics", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalytics", - "namespace": "ml._types" - } - } - } + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } - ] + } + }, + "examples": { + "MlDeleteDatafeedResponseExample1": { + "description": "A successful response when deleting a datafeed.", + "value": "{\n \"acknowledged\": true\n}" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_data_frame_analytics_stats" + "namespace": "ml.delete_datafeed" }, - "specLocation": "ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsResponse.ts#L23-L29" + "specLocation": "ml/delete_datafeed/MlDeleteDatafeedResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -30670,7 +30820,7 @@ "body": { "kind": "no_body" }, - "description": "Get datafeeds usage info.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", + "description": "Delete a filter.\n\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "inherits": { "type": { "name": "RequestBase", @@ -30680,75 +30830,48 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_datafeed_stats" + "namespace": "ml.delete_filter" }, "path": [ { - "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.", - "name": "datafeed_id", - "required": false, + "description": "A string that uniquely identifies a filter.", + "name": "filter_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "Id", "namespace": "_types" } } } ], - "query": [ - { - "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.", - "name": "allow_no_match", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts#L23-L72" + "query": [], + "specLocation": "ml/delete_filter/MlDeleteFilterRequest.ts#L23-L48" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "datafeeds", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DatafeedStats", - "namespace": "ml._types" - } - } - } + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } - ] + } + }, + "examples": { + "MlDeleteFilterResponseExample1": { + "description": "A successful response when deleting a filter.", + "value": "{\n \"acknowledged\": true\n}" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_datafeed_stats" + "namespace": "ml.delete_filter" }, - "specLocation": "ml/get_datafeed_stats/MlGetDatafeedStatsResponse.ts#L23-L28" + "specLocation": "ml/delete_filter/MlDeleteFilterResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -30757,7 +30880,7 @@ "body": { "kind": "no_body" }, - "description": "Get datafeeds configuration info.\nYou can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", + "description": "Delete an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", "inherits": { "type": { "name": "RequestBase", @@ -30767,17 +30890,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_datafeeds" + "namespace": "ml.delete_job" }, "path": [ { - "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.", - "name": "datafeed_id", - "required": false, + "description": "Identifier for the anomaly detection job.", + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "Id", "namespace": "_types" } } @@ -30785,8 +30908,8 @@ ], "query": [ { - "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.", - "name": "allow_no_match", + "description": "Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.", + "name": "force", "required": false, "type": { "kind": "instance_of", @@ -30797,8 +30920,8 @@ } }, { - "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.", - "name": "exclude_generated", + "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.", + "name": "delete_user_annotations", "required": false, "serverDefault": false, "type": { @@ -30808,47 +30931,52 @@ "namespace": "_builtins" } } + }, + { + "description": "Specifies whether the request should return immediately or wait until the\njob deletion completes.", + "name": "wait_for_completion", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "ml/get_datafeeds/MlGetDatafeedsRequest.ts#L23-L78" + "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L72" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "datafeeds", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Datafeed", - "namespace": "ml._types" - } - } - } + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } - ] + } + }, + "examples": { + "MlDeleteJobResponseExample1": { + "description": "A successful response when deleting an anomaly detection job.", + "summary": "Delete job", + "value": "{\n \"acknowledged\": true\n}" + }, + "MlDeleteJobResponseExample2": { + "description": "A successful response when deleting an anomaly detection job asynchronously. When the `wait_for_completion` query parameter is set to `false`, the response contains an identifier for the job deletion task.\n", + "summary": "Delete job asynchronously", + "value": "{\n \"task\": \"oTUltX4IQMOUUVeiohTt8A:39\"\n}" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_datafeeds" + "namespace": "ml.delete_job" }, - "specLocation": "ml/get_datafeeds/MlGetDatafeedsResponse.ts#L23-L28" + "specLocation": "ml/delete_job/MlDeleteJobResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -30857,7 +30985,7 @@ "body": { "kind": "no_body" }, - "description": "Get filters.\nYou can get a single filter or all filters.", + "description": "Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -30867,17 +30995,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_filters" + "namespace": "ml.delete_trained_model" }, "path": [ { - "description": "A string that uniquely identifies a filter.", - "name": "filter_id", - "required": false, + "description": "The unique identifier of the trained model.", + "name": "model_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "Id", "namespace": "_types" } } @@ -30885,71 +31013,56 @@ ], "query": [ { - "description": "Skips the specified number of filters.", - "name": "from", + "description": "Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.", + "name": "force", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Specifies the maximum number of filters to obtain.", - "name": "size", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", "required": false, - "serverDefault": 100, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Duration", "namespace": "_types" } } } ], - "specLocation": "ml/get_filters/MlGetFiltersRequest.ts#L24-L63" + "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelRequest.ts#L24-L57" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "filters", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Filter", - "namespace": "ml._types" - } - } - } + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" } - ] + } + }, + "examples": { + "MlDeleteTrainedModelResponseExample1": { + "description": "A successful response when deleting an existing trained inference model.", + "value": "{\n \"acknowledged\": true\n}" + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_filters" + "namespace": "ml.delete_trained_model" }, - "specLocation": "ml/get_filters/MlGetFiltersResponse.ts#L23-L28" + "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -30958,7 +31071,7 @@ "body": { "kind": "no_body" }, - "description": "Get anomaly detection jobs usage info.", + "description": "Delete a trained model alias.\n\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "inherits": { "type": { "name": "RequestBase", @@ -30968,85 +31081,135 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_job_stats" + "namespace": "ml.delete_trained_model_alias" }, "path": [ { - "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.", - "name": "job_id", - "required": false, + "description": "The model alias to delete.", + "name": "model_alias", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Name", "namespace": "_types" } } - } - ], - "query": [ + }, { - "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.", - "name": "allow_no_match", - "required": false, - "serverDefault": true, + "description": "The trained model ID to which the model alias refers.", + "name": "model_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } } ], - "specLocation": "ml/get_job_stats/MlGetJobStatsRequest.ts#L23-L68" + "query": [], + "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts#L23-L53" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "examples": { + "MlDeleteTrainedModelAliasResponseExample1": { + "description": "A successful response when deleting a trained model alias.", + "value": "{\n \"acknowledged\": true\n}" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.delete_trained_model_alias" + }, + "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasResponse.ts#L22-L24" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], "body": { "kind": "properties", "properties": [ { - "name": "count", - "required": true, + "description": "For a list of the properties that you can specify in the\n`analysis_config` component of the body of this API.", + "name": "analysis_config", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "AnalysisConfig", + "namespace": "ml._types" } } }, { - "name": "jobs", - "required": true, + "description": "Estimates of the highest cardinality in a single bucket that is observed\nfor influencer fields over the time period that the job analyzes data.\nTo produce a good answer, values must be provided for all influencer\nfields. Providing values for fields that are not listed as `influencers`\nhas no effect on the estimation.", + "name": "max_bucket_cardinality", + "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "JobStats", - "namespace": "ml._types" + "name": "long", + "namespace": "_types" + } + } + } + }, + { + "description": "Estimates of the cardinality that is observed for fields over the whole\ntime period that the job analyzes data. To produce a good answer, values\nmust be provided for fields referenced in the `by_field_name`,\n`over_field_name` and `partition_field_name` of any detectors. Providing\nvalues for other fields has no effect on the estimation. It can be\nomitted from the request if no detectors have a `by_field_name`,\n`over_field_name` or `partition_field_name`.", + "name": "overall_cardinality", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } } } ] }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.get_job_stats" - }, - "specLocation": "ml/get_job_stats/MlGetJobStatsResponse.ts#L23-L28" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" + "description": "Estimate job model memory usage.\n\nMake an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "examples": { + "MlEstimateModelMemoryRequestExample1": { + "description": "Run `POST _ml/anomaly_detectors/_estimate_model_memory` to estimate the model memory limit based on the analysis configuration details provided in the request body.", + "value": "{\n \"analysis_config\": {\n \"bucket_span\": \"5m\",\n \"detectors\": [\n {\n \"function\": \"sum\",\n \"field_name\": \"bytes\",\n \"by_field_name\": \"status\",\n \"partition_field_name\": \"app\"\n }\n ],\n \"influencers\": [\n \"source_ip\",\n \"dest_ip\"\n ]\n },\n \"overall_cardinality\": {\n \"status\": 10,\n \"app\": 50\n },\n \"max_bucket_cardinality\": {\n \"source_ip\": 300,\n \"dest_ip\": 30\n }\n}" + } }, - "description": "Get anomaly detection jobs configuration info.\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the ``, or by omitting the ``.", "inherits": { "type": { "name": "RequestBase", @@ -31056,125 +31219,208 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_jobs" + "namespace": "ml.estimate_model_memory" }, - "path": [ - { - "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.", - "name": "job_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Ids", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "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.", - "name": "allow_no_match", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "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.", - "name": "exclude_generated", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", + "path": [], + "query": [], + "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L71" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "model_memory_estimate", + "required": true, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } + ] + }, + "examples": { + "MlEstimateModelMemoryResponseExample1": { + "description": "A successful response from `POST _ml/anomaly_detectors/_estimate_model_memory`.", + "value": "{\n \"model_memory_estimate\": \"21mb\"\n}" } - ], - "specLocation": "ml/get_jobs/MlGetJobsRequest.ts#L23-L78" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.estimate_model_memory" + }, + "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryResponse.ts#L20-L24" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], "body": { "kind": "properties", "properties": [ { - "name": "count", + "description": "Defines the type of evaluation you want to perform.", + "name": "evaluation", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "DataframeEvaluationContainer", + "namespace": "ml._types" } } }, { - "name": "jobs", + "description": "Defines the `index` in which the evaluation will be performed.", + "name": "index", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Job", - "namespace": "ml._types" - } + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "description": "A query clause that retrieves a subset of data from the source index.", + "docId": "query-dsl", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "name": "query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } } ] }, - "kind": "response", + "description": "Evaluate data frame analytics.\n\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", + "examples": { + "MlEvaluateDataFrameRequestExample1": { + "description": "Run `POST _ml/data_frame/_evaluate` to evaluate a a classification job for an annotated index. The `actual_field` contains the ground truth for classification. The `predicted_field` contains the predicted value calculated by the classification analysis.\n", + "summary": "Classification example 1", + "value": "{\n \"index\": \"animal_classification\",\n \"evaluation\": {\n \"classification\": {\n \"actual_field\": \"animal_class\",\n \"predicted_field\": \"ml.animal_class_prediction\",\n \"metrics\": {\n \"multiclass_confusion_matrix\": {}\n }\n }\n }\n}" + }, + "MlEvaluateDataFrameRequestExample2": { + "description": "Run `POST _ml/data_frame/_evaluate` to evaluate a classification job with AUC ROC metrics for an annotated index. The `actual_field` contains the ground truth value for the actual animal classification. This is required in order to evaluate results. The `class_name` specifies the class name that is treated as positive during the evaluation, all the other classes are treated as negative.\n", + "summary": "Classification example 2", + "value": "{\n \"index\": \"animal_classification\",\n \"evaluation\": {\n \"classification\": {\n \"actual_field\": \"animal_class\",\n \"metrics\": {\n \"auc_roc\": {\n \"class_name\": \"dog\"\n }\n }\n }\n }\n}" + }, + "MlEvaluateDataFrameRequestExample3": { + "description": "Run `POST _ml/data_frame/_evaluate` to evaluate an outlier detection job for an annotated index.\n", + "summary": "Outlier detection", + "value": "{\n \"index\": \"my_analytics_dest_index\",\n \"evaluation\": {\n \"outlier_detection\": {\n \"actual_field\": \"is_outlier\",\n \"predicted_probability_field\": \"ml.outlier_score\"\n }\n }\n}" + }, + "MlEvaluateDataFrameRequestExample4": { + "description": "Run `POST _ml/data_frame/_evaluate` to evaluate the testing error of a regression job for an annotated index. The term query in the body limits evaluation to be performed on the test split only. The `actual_field` contains the ground truth for house prices. The `predicted_field` contains the house price calculated by the regression analysis.\n", + "summary": "Regression example 1", + "value": "{\n \"index\": \"house_price_predictions\",\n \"query\": {\n \"bool\": {\n \"filter\": [\n {\n \"term\": {\n \"ml.is_training\": false\n }\n }\n ]\n }\n },\n \"evaluation\": {\n \"regression\": {\n \"actual_field\": \"price\",\n \"predicted_field\": \"ml.price_prediction\",\n \"metrics\": {\n \"r_squared\": {},\n \"mse\": {},\n \"msle\": {\n \"offset\": 10\n },\n \"huber\": {\n \"delta\": 1.5\n }\n }\n }\n }\n}" + }, + "MlEvaluateDataFrameRequestExample5": { + "description": "Run `POST _ml/data_frame/_evaluate` to evaluate the training error of a regression job for an annotated index. The term query in the body limits evaluation to be performed on the training split only. The `actual_field` contains the ground truth for house prices. The `predicted_field` contains the house price calculated by the regression analysis.\n", + "summary": "Regression example 2", + "value": "{\n \"index\": \"house_price_predictions\",\n \"query\": {\n \"term\": {\n \"ml.is_training\": {\n \"value\": true\n }\n }\n },\n \"evaluation\": {\n \"regression\": {\n \"actual_field\": \"price\",\n \"predicted_field\": \"ml.price_prediction\",\n \"metrics\": {\n \"r_squared\": {},\n \"mse\": {},\n \"msle\": {},\n \"huber\": {}\n }\n }\n }\n}" + } + }, + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", "name": { - "name": "Response", - "namespace": "ml.get_jobs" + "name": "Request", + "namespace": "ml.evaluate_data_frame" }, - "specLocation": "ml/get_jobs/MlGetJobsResponse.ts#L23-L28" + "path": [], + "query": [], + "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts#L25-L61" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], "body": { "kind": "properties", "properties": [ { - "description": "Refer to the description for the `allow_no_match` query parameter.", - "name": "allow_no_match", + "description": "Evaluation results for a classification analysis.\nIt outputs a prediction that identifies to which of the classes each document belongs.", + "name": "classification", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DataframeClassificationSummary", + "namespace": "ml.evaluate_data_frame" } } }, { - "description": "Refer to the description for the `bucket_span` query parameter.", - "name": "bucket_span", + "description": "Evaluation results for an outlier detection analysis.\nIt outputs the probability that each document is an outlier.", + "name": "outlier_detection", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "DataframeOutlierDetectionSummary", + "namespace": "ml.evaluate_data_frame" } } }, { - "description": "Refer to the description for the `end` query parameter.", - "name": "end", + "description": "Evaluation results for a regression analysis which outputs a prediction of values.", + "name": "regression", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataframeRegressionSummary", + "namespace": "ml.evaluate_data_frame" + } + } + } + ] + }, + "examples": { + "MlEvaluateDataFrameResponseExample1": { + "description": "A succesful response from `POST _ml/data_frame/_evaluate` to evaluate a classification analysis job for an annotated index. The `actual_class` contains the name of the class the analysis tried to predict. The `actual_class_doc_count` is the number of documents in the index belonging to the `actual_class`. The `predicted_classes` object contains the list of the predicted classes and the number of predictions associated with the class.\n", + "summary": "Classification example 1", + "value": "{\n \"classification\": {\n \"multiclass_confusion_matrix\": {\n \"confusion_matrix\": [\n {\n \"actual_class\": \"cat\",\n \"actual_class_doc_count\": 12,\n \"predicted_classes\": [\n {\n \"predicted_class\": \"cat\",\n \"count\": 12\n },\n {\n \"predicted_class\": \"dog\",\n \"count\": 0\n }\n ],\n \"other_predicted_class_doc_count\": 0\n },\n {\n \"actual_class\": \"dog\",\n \"actual_class_doc_count\": 11,\n \"predicted_classes\": [\n {\n \"predicted_class\": \"dog\",\n \"count\": 7\n },\n {\n \"predicted_class\": \"cat\",\n \"count\": 4\n }\n ],\n \"other_predicted_class_doc_count\": 0\n }\n ],\n \"other_actual_class_count\": 0\n }\n }\n}" + }, + "MlEvaluateDataFrameResponseExample2": { + "description": "A succesful response from `POST _ml/data_frame/_evaluate` to evaluate a classification analysis job with the AUC ROC metrics for an annotated index.\n", + "summary": "Classification example 2", + "value": "{\n \"classification\": {\n \"auc_roc\": {\n \"value\": 0.8941788639536681\n }\n }\n}" + }, + "MlEvaluateDataFrameResponseExample3": { + "description": "A successful response from `POST _ml/data_frame/_evaluate` to evaluate an outlier detection job.", + "summary": "Outlier detection", + "value": "{\n \"outlier_detection\": {\n \"auc_roc\": {\n \"value\": 0.9258475774641445\n },\n \"confusion_matrix\": {\n \"0.25\": {\n \"tp\": 5,\n \"fp\": 9,\n \"tn\": 204,\n \"fn\": 5\n },\n \"0.5\": {\n \"tp\": 1,\n \"fp\": 5,\n \"tn\": 208,\n \"fn\": 9\n },\n \"0.75\": {\n \"tp\": 0,\n \"fp\": 4,\n \"tn\": 209,\n \"fn\": 10\n }\n },\n \"precision\": {\n \"0.25\": 0.35714285714285715,\n \"0.5\": 0.16666666666666666,\n \"0.75\": 0\n },\n \"recall\": {\n \"0.25\": 0.5,\n \"0.5\": 0.1,\n \"0.75\": 0\n }\n }\n}" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.evaluate_data_frame" + }, + "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameResponse.ts#L26-L44" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Refer to the description for the `advance_time` query parameter.", + "name": "advance_time", "required": false, "type": { "kind": "instance_of", @@ -31185,10 +31431,9 @@ } }, { - "description": "Refer to the description for the `exclude_interim` query parameter.", - "name": "exclude_interim", + "description": "Refer to the description for the `calc_interim` query parameter.", + "name": "calc_interim", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -31198,32 +31443,20 @@ } }, { - "description": "Refer to the description for the `overall_score` query parameter.", - "name": "overall_score", + "description": "Refer to the description for the `end` query parameter.", + "name": "end", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } } }, { - "description": "Refer to the description for the `start` query parameter.", - "name": "start", + "description": "Refer to the description for the `skip_time` query parameter.", + "name": "skip_time", "required": false, "type": { "kind": "instance_of", @@ -31234,21 +31467,20 @@ } }, { - "description": "Refer to the description for the `top_n` query parameter.", - "name": "top_n", + "description": "Refer to the description for the `start` query parameter.", + "name": "start", "required": false, - "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "DateTime", "namespace": "_types" } } } ] }, - "description": "Get overall bucket results.\n\nRetrievs overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", + "description": "Force buffered data to be processed.\nThe flush jobs API is only applicable when sending data for analysis using\nthe post data API. Depending on the content of the buffer, then it might\nadditionally calculate new results. Both flush and close operations are\nsimilar, however the flush is more efficient if you are expecting to send\nmore data for analysis. When flushing, the job remains open and is available\nto continue analyzing data. A close operation additionally prunes and\npersists the model state to disk and the job must be opened again before\nanalyzing further data.", "inherits": { "type": { "name": "RequestBase", @@ -31258,11 +31490,11 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_overall_buckets" + "namespace": "ml.flush_job" }, "path": [ { - "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 ``.", + "description": "Identifier for the anomaly detection job.", "name": "job_id", "required": true, "type": { @@ -31276,32 +31508,31 @@ ], "query": [ { - "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.", - "name": "allow_no_match", + "description": "Specifies to advance to a particular time value. Results are generated\nand the model is updated for data from the specified time interval.", + "name": "advance_time", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "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.", - "name": "bucket_span", + "description": "If true, calculates the interim results for the most recent bucket or all\nbuckets within the latency period.", + "name": "calc_interim", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Returns overall buckets with timestamps earlier than this time.", + "description": "When used in conjunction with `calc_interim` and `start`, specifies the\nrange of buckets on which to calculate interim results.", "name": "end", "required": false, "type": { @@ -31313,45 +31544,105 @@ } }, { - "description": "If `true`, the output excludes interim results.", - "name": "exclude_interim", + "description": "Specifies to skip to a particular time value. Results are not generated\nand the model is not updated for data from the specified time interval.", + "name": "skip_time", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "description": "Returns overall buckets with overall scores greater than or equal to this\nvalue.", - "name": "overall_score", + "description": "When used in conjunction with `calc_interim`, specifies the range of\nbuckets on which to calculate interim results.", + "name": "start", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } + } + } + ], + "specLocation": "ml/flush_job/MlFlushJobRequest.ts#L24-L107" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "flushed", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } - ], - "kind": "union_of" + } + }, + { + "description": "Provides the timestamp (in milliseconds since the epoch) of the end of\nthe last bucket that was processed.", + "name": "last_finalized_bucket_end", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } - }, + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.flush_job" + }, + "specLocation": "ml/flush_job/MlFlushJobResponse.ts#L22-L31" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Get info about events in calendars.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_calendar_events" + }, + "path": [ { - "description": "Returns overall buckets with timestamps after this time.", - "name": "start", + "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.", + "name": "calendar_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Specifies to get events with timestamps earlier than this time.", + "name": "end", "required": false, "type": { "kind": "instance_of", @@ -31362,10 +31653,35 @@ } }, { - "description": "The number of top anomaly detection job bucket scores to be used in the\n`overall_score` calculation.", - "name": "top_n", + "description": "Skips the specified number of events.", + "name": "from", "required": false, - "serverDefault": 1, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`.", + "name": "job_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "Specifies the maximum number of events to obtain.", + "name": "size", + "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -31373,9 +31689,21 @@ "namespace": "_types" } } + }, + { + "description": "Specifies to get events with timestamps after this time.", + "name": "start", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } + } } ], - "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsRequest.ts#L25-L153" + "specLocation": "ml/get_calendar_events/MlGetCalendarEventsRequest.ts#L25-L61" }, { "body": { @@ -31393,15 +31721,14 @@ } }, { - "description": "Array of overall bucket objects", - "name": "overall_buckets", + "name": "events", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "OverallBucket", + "name": "CalendarEvent", "namespace": "ml._types" } } @@ -31412,18 +31739,32 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_overall_buckets" + "namespace": "ml.get_calendar_events" }, - "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsResponse.ts#L23-L29" + "specLocation": "ml/get_calendar_events/MlGetCalendarEventsResponse.ts#L23-L28" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" + "kind": "properties", + "properties": [ + { + "description": "This object is supported only when you omit the calendar identifier.", + "name": "page", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Page", + "namespace": "ml._types" + } + } + } + ] }, - "description": "Get trained model configuration info.", + "description": "Get calendar configuration info.", "inherits": { "type": { "name": "RequestBase", @@ -31433,17 +31774,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_trained_models" + "namespace": "ml.get_calendars" }, "path": [ { - "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.", - "name": "model_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.", + "name": "calendar_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "Id", "namespace": "_types" } } @@ -31451,71 +31792,134 @@ ], "query": [ { - "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.", - "name": "allow_no_match", + "description": "Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier.", + "name": "from", "required": false, - "serverDefault": true, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Specifies whether the included model definition should be returned as a\nJSON map (true) or in a custom compressed format (false).", - "name": "decompress_definition", + "description": "Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier.", + "name": "size", "required": false, - "serverDefault": true, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "ml/get_calendars/MlGetCalendarsRequest.ts#L25-L63" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "calendars", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Calendar", + "namespace": "ml.get_calendars" + } + } + } + }, + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_calendars" + }, + "specLocation": "ml/get_calendars/MlGetCalendarsResponse.ts#L23-L25" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Get data frame analytics job configuration info.\nYou can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_data_frame_analytics" + }, + "path": [ { - "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.", - "name": "exclude_generated", + "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.", + "name": "id", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "Skips the specified number of models.", - "name": "from", + "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.", + "name": "allow_no_match", "required": false, - "serverDefault": 0, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "A comma delimited string of optional fields to include in the response\nbody.", - "name": "include", + "description": "Skips the specified number of data frame analytics jobs.", + "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "Include", - "namespace": "ml._types" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Specifies the maximum number of models to obtain.", + "description": "Specifies the maximum number of data frame analytics jobs to obtain.", "name": "size", "required": false, "serverDefault": 100, @@ -31528,34 +31932,20 @@ } }, { - "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.", - "name": "tags", + "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.", + "name": "exclude_generated", "required": false, + "serverDefault": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } } ], - "specLocation": "ml/get_trained_models/MlGetTrainedModelRequest.ts#L25-L104" + "specLocation": "ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts#L24-L89" }, { "body": { @@ -31573,15 +31963,15 @@ } }, { - "description": "An array of trained model resources, which are sorted by the model_id value in ascending order.", - "name": "trained_model_configs", + "description": "An array of data frame analytics job resources, which are sorted by the id value in ascending order.", + "name": "data_frame_analytics", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "TrainedModelConfig", + "name": "DataframeAnalyticsSummary", "namespace": "ml._types" } } @@ -31592,9 +31982,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_trained_models" + "namespace": "ml.get_data_frame_analytics" }, - "specLocation": "ml/get_trained_models/MlGetTrainedModelResponse.ts#L23-L34" + "specLocation": "ml/get_data_frame_analytics/MlGetDataFrameAnalyticsResponse.ts#L23-L29" }, { "attachedBehaviors": [ @@ -31603,7 +31993,7 @@ "body": { "kind": "no_body" }, - "description": "Get trained models usage info.\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.", + "description": "Get data frame analytics jobs usage info.", "inherits": { "type": { "name": "RequestBase", @@ -31613,17 +32003,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.get_trained_models_stats" + "namespace": "ml.get_data_frame_analytics_stats" }, "path": [ { - "description": "The unique identifier of the trained model or a model alias. It can be a\ncomma-separated list or a wildcard expression.", - "name": "model_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.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "Id", "namespace": "_types" } } @@ -31631,7 +32021,7 @@ ], "query": [ { - "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.", + "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.", "name": "allow_no_match", "required": false, "serverDefault": true, @@ -31644,7 +32034,7 @@ } }, { - "description": "Skips the specified number of models.", + "description": "Skips the specified number of data frame analytics jobs.", "name": "from", "required": false, "serverDefault": 0, @@ -31657,7 +32047,7 @@ } }, { - "description": "Specifies the maximum number of models to obtain.", + "description": "Specifies the maximum number of data frame analytics jobs to obtain.", "name": "size", "required": false, "serverDefault": 100, @@ -31668,36 +32058,48 @@ "namespace": "_types" } } + }, + { + "description": "Defines whether the stats response should be verbose.", + "name": "verbose", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts#L24-L77" + "specLocation": "ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts#L24-L84" }, { "body": { "kind": "properties", "properties": [ { - "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.", "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "description": "An array of trained model statistics, which are sorted by the model_id value in ascending order.", - "name": "trained_model_stats", + "description": "An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order.", + "name": "data_frame_analytics", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "TrainedModelStats", + "name": "DataframeAnalytics", "namespace": "ml._types" } } @@ -31708,54 +32110,18 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.get_trained_models_stats" + "namespace": "ml.get_data_frame_analytics_stats" }, - "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsResponse.ts#L23-L33" + "specLocation": "ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsResponse.ts#L23-L29" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "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.", - "name": "docs", - "required": true, - "type": { - "kind": "array_of", - "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - } - }, - { - "description": "The inference configuration updates to apply on the API call", - "name": "inference_config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "InferenceConfigUpdateContainer", - "namespace": "ml._types" - } - } - } - ] + "kind": "no_body" }, - "description": "Evaluate a trained model.", + "description": "Get datafeeds usage info.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", "inherits": { "type": { "name": "RequestBase", @@ -31765,17 +32131,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.infer_trained_model" + "namespace": "ml.get_datafeed_stats" }, "path": [ { - "description": "The unique identifier of the trained model.", - "name": "model_id", - "required": true, + "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.", + "name": "datafeed_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Ids", "namespace": "_types" } } @@ -31783,34 +32149,44 @@ ], "query": [ { - "description": "Controls the amount of time to wait for inference results.", - "name": "timeout", + "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.", + "name": "allow_no_match", "required": false, - "serverDefault": "10s", "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "ml/infer_trained_model/MlInferTrainedModelRequest.ts#L27-L67" + "specLocation": "ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts#L23-L72" }, { "body": { "kind": "properties", "properties": [ { - "name": "inference_results", + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "datafeeds", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "InferenceResponseResult", + "name": "DatafeedStats", "namespace": "ml._types" } } @@ -31821,39 +32197,18 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.infer_trained_model" + "namespace": "ml.get_datafeed_stats" }, - "specLocation": "ml/infer_trained_model/MlInferTrainedModelResponse.ts#L22-L26" + "specLocation": "ml/get_datafeed_stats/MlGetDatafeedStatsResponse.ts#L23-L28" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "description": "Refer to the description for the `timeout` query parameter.", - "name": "timeout", - "required": false, - "serverDefault": "30m", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ] - }, - "description": "Open anomaly detection jobs.\n\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", - "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}" - } + "kind": "no_body" }, + "description": "Get datafeeds configuration info.\nYou can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", "inherits": { "type": { "name": "RequestBase", @@ -31863,17 +32218,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.open_job" + "namespace": "ml.get_datafeeds" }, "path": [ { - "description": "Identifier for the anomaly detection job.", - "name": "job_id", - "required": true, + "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.", + "name": "datafeed_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Ids", "namespace": "_types" } } @@ -31881,88 +32236,79 @@ ], "query": [ { - "description": "Controls the time to wait until a job has opened.", - "name": "timeout", + "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.", + "name": "allow_no_match", "required": false, - "serverDefault": "30m", "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "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.", + "name": "exclude_generated", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L67" + "specLocation": "ml/get_datafeeds/MlGetDatafeedsRequest.ts#L23-L78" }, { "body": { "kind": "properties", "properties": [ { - "name": "opened", + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "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.", - "name": "node", + "name": "datafeeds", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "NodeId", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Datafeed", + "namespace": "ml._types" + } } } } ] }, - "examples": { - "MlOpenJobResponseExample1": { - "description": "A successful response when opening an anomaly detection job.", - "value": "{\n \"opened\": true,\n \"node\": \"node-1\"\n}" - } - }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.open_job" + "namespace": "ml.get_datafeeds" }, - "specLocation": "ml/open_job/MlOpenJobResponse.ts#L22-L31" + "specLocation": "ml/get_datafeeds/MlGetDatafeedsResponse.ts#L23-L28" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "description": "A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.", - "name": "events", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CalendarEvent", - "namespace": "ml._types" - } - } - } - } - ] + "kind": "no_body" }, - "description": "Add scheduled events to the calendar.", + "description": "Get filters.\nYou can get a single filter or all filters.", "inherits": { "type": { "name": "RequestBase", @@ -31972,38 +32318,76 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.post_calendar_events" + "namespace": "ml.get_filters" }, "path": [ { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_id", - "required": true, + "description": "A string that uniquely identifies a filter.", + "name": "filter_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Ids", "namespace": "_types" } } } ], - "query": [], - "specLocation": "ml/post_calendar_events/MlPostCalendarEventsRequest.ts#L24-L48" + "query": [ + { + "description": "Skips the specified number of filters.", + "name": "from", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Specifies the maximum number of filters to obtain.", + "name": "size", + "required": false, + "serverDefault": 100, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "ml/get_filters/MlGetFiltersRequest.ts#L24-L63" }, { "body": { "kind": "properties", "properties": [ { - "name": "events", + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "filters", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "CalendarEvent", + "name": "Filter", "namespace": "ml._types" } } @@ -32014,34 +32398,18 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.post_calendar_events" + "namespace": "ml.get_filters" }, - "specLocation": "ml/post_calendar_events/MlPostCalendarEventsResponse.ts#L22-L24" + "specLocation": "ml/get_filters/MlGetFiltersResponse.ts#L23-L28" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "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.", - "docId": "put-dfanalytics", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics", - "name": "config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframePreviewConfig", - "namespace": "ml.preview_data_frame_analytics" - } - } - } - ] + "kind": "no_body" }, - "description": "Preview features used by data frame analytics.\nPreview the extracted features used by a data frame analytics config.", + "description": "Get anomaly detection jobs usage info.", "inherits": { "type": { "name": "RequestBase", @@ -32051,12 +32419,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.preview_data_frame_analytics" + "namespace": "ml.get_job_stats" }, "path": [ { - "description": "Identifier for the data frame analytics job.", - "name": "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.", + "name": "job_id", "required": false, "type": { "kind": "instance_of", @@ -32067,35 +32435,48 @@ } } ], - "query": [], - "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts#L24-L60" + "query": [ + { + "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.", + "name": "allow_no_match", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ml/get_job_stats/MlGetJobStatsRequest.ts#L23-L68" }, { "body": { "kind": "properties", "properties": [ { - "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.", - "name": "feature_values", + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "jobs", "required": true, "type": { "kind": "array_of", "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "JobStats", + "namespace": "ml._types" } } } @@ -32105,44 +32486,18 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.preview_data_frame_analytics" + "namespace": "ml.get_job_stats" }, - "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsResponse.ts#L23-L28" + "specLocation": "ml/get_job_stats/MlGetJobStatsResponse.ts#L23-L28" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "description": "The datafeed definition to preview.", - "name": "datafeed_config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DatafeedConfig", - "namespace": "ml._types" - } - } - }, - { - "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.", - "name": "job_config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "JobConfig", - "namespace": "ml._types" - } - } - } - ] + "kind": "no_body" }, - "description": "Preview a datafeed.\nThis API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", + "description": "Get anomaly detection jobs configuration info.\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the ``, or by omitting the ``.", "inherits": { "type": { "name": "RequestBase", @@ -32152,17 +32507,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.preview_datafeed" + "namespace": "ml.get_jobs" }, "path": [ { - "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.", - "name": "datafeed_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.", + "name": "job_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Ids", "namespace": "_types" } } @@ -32170,59 +32525,71 @@ ], "query": [ { - "description": "The start time from where the datafeed preview should begin", - "name": "start", + "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.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The end time when the datafeed preview should stop", - "name": "end", + "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.", + "name": "exclude_generated", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "ml/preview_datafeed/MlPreviewDatafeedRequest.ts#L26-L81" + "specLocation": "ml/get_jobs/MlGetJobsRequest.ts#L23-L78" }, { "body": { - "codegenName": "documents", - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, "type": { - "name": "TDocument", - "namespace": "ml.preview_datafeed.Response" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "jobs", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Job", + "namespace": "ml._types" + } + } } } - } + ] }, - "generics": [ - { - "name": "TDocument", - "namespace": "ml.preview_datafeed.Response" - } - ], "kind": "response", "name": { "name": "Response", - "namespace": "ml.preview_datafeed" + "namespace": "ml.get_jobs" }, - "specLocation": "ml/preview_datafeed/MlPreviewDatafeedResponse.ts#L20-L23" + "specLocation": "ml/get_jobs/MlGetJobsResponse.ts#L23-L28" }, { "attachedBehaviors": [ @@ -32232,120 +32599,107 @@ "kind": "properties", "properties": [ { - "description": "An array of anomaly detection job identifiers.", - "name": "job_ids", + "description": "Refer to the description for the `allow_no_match` query parameter.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "A description of the calendar.", - "name": "description", + "description": "Refer to the description for the `bucket_span` query parameter.", + "name": "bucket_span", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } - } - ] - }, - "description": "Create a calendar.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.put_calendar" - }, - "path": [ - { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "ml/put_calendar/MlPutCalendarRequest.ts#L23-L51" - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_id", - "required": true, + "description": "Refer to the description for the `end` query parameter.", + "name": "end", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "DateTime", "namespace": "_types" } } }, { - "description": "A description of the calendar.", - "name": "description", + "description": "Refer to the description for the `exclude_interim` query parameter.", + "name": "exclude_interim", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "A list of anomaly detection job identifiers or group names.", - "name": "job_ids", - "required": true, + "description": "Refer to the description for the `overall_score` query parameter.", + "name": "overall_score", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "Refer to the description for the `start` query parameter.", + "name": "start", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "DateTime", + "namespace": "_types" + } + } + }, + { + "description": "Refer to the description for the `top_n` query parameter.", + "name": "top_n", + "required": false, + "serverDefault": 1, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", "namespace": "_types" } } } ] }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.put_calendar" - }, - "specLocation": "ml/put_calendar/MlPutCalendarResponse.ts#L22-L31" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Add anomaly detection job to calendar.", + "description": "Get overall bucket results.\n\nRetrievs overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", "inherits": { "type": { "name": "RequestBase", @@ -32355,12 +32709,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_calendar_job" + "namespace": "ml.get_overall_buckets" }, "path": [ { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_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 ``.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", @@ -32369,228 +32723,338 @@ "namespace": "_types" } } + } + ], + "query": [ + { + "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.", + "name": "allow_no_match", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", - "name": "job_id", - "required": true, + "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.", + "name": "bucket_span", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "Duration", "namespace": "_types" } } - } - ], - "query": [], - "specLocation": "ml/put_calendar_job/MlPutCalendarJobRequest.ts#L23-L45" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "description": "A string that uniquely identifies a calendar.", - "name": "calendar_id", - "required": true, + }, + { + "description": "Returns overall buckets with timestamps earlier than this time.", + "name": "end", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "name": "DateTime", + "namespace": "_types" } - }, - { - "description": "A description of the calendar.", - "name": "description", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + } + }, + { + "description": "If `true`, the output excludes interim results.", + "name": "exclude_interim", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Returns overall buckets with overall scores greater than or equal to this\nvalue.", + "name": "overall_score", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } + ], + "kind": "union_of" + } + }, + { + "description": "Returns overall buckets with timestamps after this time.", + "name": "start", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" } - }, + } + }, + { + "description": "The number of top anomaly detection job bucket scores to be used in the\n`overall_score` calculation.", + "name": "top_n", + "required": false, + "serverDefault": 1, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsRequest.ts#L25-L153" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "description": "A list of anomaly detection job identifiers or group names.", - "name": "job_ids", + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "long", "namespace": "_types" } } + }, + { + "description": "Array of overall bucket objects", + "name": "overall_buckets", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "OverallBucket", + "namespace": "ml._types" + } + } + } } ] }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.put_calendar_job" + "namespace": "ml.get_overall_buckets" }, - "specLocation": "ml/put_calendar_job/MlPutCalendarJobResponse.ts#L22-L31" + "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsResponse.ts#L23-L29" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node. If\nset to `false` and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to `true`,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.", - "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", - "name": "allow_lazy_start", - "required": false, - "serverDefault": false, + "kind": "no_body" + }, + "description": "Get trained model configuration info.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.get_trained_models" + }, + "path": [ + { + "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.", + "name": "model_id", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "name": "Ids", + "namespace": "_types" } - }, - { - "description": "The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.", - "name": "analysis", - "required": true, + } + } + ], + "query": [ + { + "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.", + "name": "allow_no_match", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalysisContainer", - "namespace": "ml._types" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "description": "Specifies `includes` and/or `excludes` patterns to select which fields\nwill be included in the analysis. The patterns specified in `excludes`\nare applied last, therefore `excludes` takes precedence. In other words,\nif the same field is specified in both `includes` and `excludes`, then\nthe field will not be included in the analysis. If `analyzed_fields` is\nnot set, only the relevant fields will be included. For example, all the\nnumeric fields for outlier detection.\nThe supported fields vary for each type of analysis. Outlier detection\nrequires numeric or `boolean` data to analyze. The algorithms don’t\nsupport missing values therefore fields that have data types other than\nnumeric or boolean are ignored. Documents where included fields contain\nmissing values, null values, or an array are also ignored. Therefore the\n`dest` index may contain documents that don’t have an outlier score.\nRegression supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the regression analysis.\nClassification supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the classification analysis.\nClassification analysis can be improved by mapping ordinal variable\nvalues to a single number. For example, in case of age ranges, you can\nmodel the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on.", - "name": "analyzed_fields", - "required": false, + } + }, + { + "description": "Specifies whether the included model definition should be returned as a\nJSON map (true) or in a custom compressed format (false).", + "name": "decompress_definition", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalysisAnalyzedFields", - "namespace": "ml._types" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "description": "A description of the job.", - "name": "description", - "required": false, + } + }, + { + "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.", + "name": "exclude_generated", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "description": "The destination configuration.", - "name": "dest", - "required": true, + } + }, + { + "description": "Skips the specified number of models.", + "name": "from", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsDestination", - "namespace": "ml._types" - } + "name": "integer", + "namespace": "_types" } - }, - { - "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.", - "name": "max_num_threads", - "required": false, - "serverDefault": 1, + } + }, + { + "description": "A comma delimited string of optional fields to include in the response\nbody.", + "name": "include", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "Include", + "namespace": "ml._types" } - }, - { - "name": "_meta", - "required": false, + } + }, + { + "description": "Specifies the maximum number of models to obtain.", + "name": "size", + "required": false, + "serverDefault": 100, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } - }, - { - "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.", - "name": "model_memory_limit", - "required": false, - "serverDefault": "1gb", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + } + }, + { + "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.", + "name": "tags", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - } - }, + ], + "kind": "union_of" + } + } + ], + "specLocation": "ml/get_trained_models/MlGetTrainedModelRequest.ts#L25-L104" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "description": "The configuration of how to source the analysis data.", - "name": "source", + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsSource", - "namespace": "ml._types" - } - } - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "8.0.0" - } - }, - "name": "headers", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "HttpHeaders", + "name": "integer", "namespace": "_types" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "name": "version", - "required": false, + "description": "An array of trained model resources, which are sorted by the model_id value in ascending order.", + "name": "trained_model_configs", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TrainedModelConfig", + "namespace": "ml._types" + } } } } ] }, - "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.\nBy default, the query used in the source configuration is `{\"match_all\": {}}`.\n\nIf the destination index does not exist, it is created automatically when you start the job.\n\nIf you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.", + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_trained_models" + }, + "specLocation": "ml/get_trained_models/MlGetTrainedModelResponse.ts#L23-L34" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Get trained models usage info.\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.", "inherits": { "type": { "name": "RequestBase", @@ -32600,189 +33064,330 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_data_frame_analytics" + "namespace": "ml.get_trained_models_stats" }, "path": [ { - "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.", - "name": "id", - "required": true, + "description": "The unique identifier of the trained model or a model alias. It can be a\ncomma-separated list or a wildcard expression.", + "name": "model_id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Ids", "namespace": "_types" } } } ], - "query": [], - "specLocation": "ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts#L30-L155" + "query": [ + { + "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.", + "name": "allow_no_match", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Skips the specified number of models.", + "name": "from", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Specifies the maximum number of models to obtain.", + "name": "size", + "required": false, + "serverDefault": 100, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts#L24-L77" }, { "body": { "kind": "properties", "properties": [ { - "name": "authorization", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsAuthorization", - "namespace": "ml._types" - } - } - }, - { - "name": "allow_lazy_start", + "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.", + "name": "count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "analysis", + "description": "An array of trained model statistics, which are sorted by the model_id value in ascending order.", + "name": "trained_model_stats", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalysisContainer", - "namespace": "ml._types" - } - } - }, - { - "name": "analyzed_fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalysisAnalyzedFields", - "namespace": "ml._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TrainedModelStats", + "namespace": "ml._types" + } } } - }, + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.get_trained_models_stats" + }, + "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsResponse.ts#L23-L33" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ { - "name": "create_time", + "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.", + "name": "docs", "required": true, "type": { - "generics": [ - { + "kind": "array_of", + "value": { + "key": { "kind": "instance_of", "type": { - "name": "UnitMillis", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" } } }, { - "name": "description", + "description": "The inference configuration updates to apply on the API call", + "name": "inference_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "InferenceConfigUpdateContainer", + "namespace": "ml._types" } } - }, - { - "name": "dest", - "required": true, + } + ] + }, + "description": "Evaluate a trained model.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.infer_trained_model" + }, + "path": [ + { + "description": "The unique identifier of the trained model.", + "name": "model_id", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsDestination", - "namespace": "ml._types" - } + "name": "Id", + "namespace": "_types" } - }, - { - "name": "id", - "required": true, + } + } + ], + "query": [ + { + "description": "Controls the amount of time to wait for inference results.", + "name": "timeout", + "required": false, + "serverDefault": "10s", + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "name": "Duration", + "namespace": "_types" } - }, + } + } + ], + "specLocation": "ml/infer_trained_model/MlInferTrainedModelRequest.ts#L27-L67" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "name": "max_num_threads", + "name": "inference_results", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceResponseResult", + "namespace": "ml._types" + } } } - }, + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.infer_trained_model" + }, + "specLocation": "ml/infer_trained_model/MlInferTrainedModelResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ { - "name": "_meta", + "description": "Refer to the description for the `timeout` query parameter.", + "name": "timeout", "required": false, + "serverDefault": "30m", "type": { "kind": "instance_of", "type": { - "name": "Metadata", + "name": "Duration", "namespace": "_types" } } - }, - { - "name": "model_memory_limit", - "required": true, + } + ] + }, + "description": "Open anomaly detection jobs.\n\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", + "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}" + } + }, + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.open_job" + }, + "path": [ + { + "description": "Identifier for the anomaly detection job.", + "name": "job_id", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "Id", + "namespace": "_types" } - }, + } + } + ], + "query": [ + { + "description": "Controls the time to wait until a job has opened.", + "name": "timeout", + "required": false, + "serverDefault": "30m", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L67" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "name": "source", + "name": "opened", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalyticsSource", - "namespace": "ml._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "version", + "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.", + "name": "node", "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "NodeId", "namespace": "_types" } } } ] }, + "examples": { + "MlOpenJobResponseExample1": { + "description": "A successful response when opening an anomaly detection job.", + "value": "{\n \"opened\": true,\n \"node\": \"node-1\"\n}" + } + }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.put_data_frame_analytics" + "namespace": "ml.open_job" }, - "specLocation": "ml/put_data_frame_analytics/MlPutDataFrameAnalyticsResponse.ts#L31-L47" + "specLocation": "ml/open_job/MlOpenJobResponse.ts#L22-L31" }, { "attachedBehaviors": [ @@ -32792,211 +33397,203 @@ "kind": "properties", "properties": [ { - "aliases": [ - "aggs" - ], - "description": "If set, the datafeed performs aggregation searches.\nSupport for aggregations is limited and should be used only with low cardinality data.", - "name": "aggregations", - "required": false, + "description": "A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.", + "name": "events", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" + "name": "CalendarEvent", + "namespace": "ml._types" } } } - }, - { - "description": "Datafeeds might be required to search over long time periods, for several months or years.\nThis search is split into time chunks in order to ensure the load on Elasticsearch is managed.\nChunking configuration controls how the size of these time chunks are calculated;\nit is an advanced configuration option.", - "name": "chunking_config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ChunkingConfig", - "namespace": "ml._types" - } - } - }, - { - "description": "Specifies whether the datafeed checks for missing data and the size of the window.\nThe datafeed can optionally search over indices that have already been read in an effort to determine whether\nany data has subsequently been added to the index. If missing data is found, it is a good indication that the\n`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time.\nThis check runs only on real-time datafeeds.", - "name": "delayed_data_check_config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DelayedDataCheckConfig", - "namespace": "ml._types" - } - } - }, - { - "description": "The interval at which scheduled queries are made while the datafeed runs in real time.\nThe default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible\nfraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last\n(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses\naggregations, this value must be divisible by the interval of the date histogram aggregation.", - "name": "frequency", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "aliases": [ - "indexes" - ], - "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master\nnodes and the machine learning nodes must have the `remote_cluster_client` role.", - "name": "indices", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } - }, - { - "description": "Specifies index expansion options that are used during search", - "name": "indices_options", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndicesOptions", - "namespace": "_types" - } - } - }, - { - "description": "Identifier for the anomaly detection job.", - "name": "job_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "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.", - "name": "max_empty_searches", - "required": false, + } + ] + }, + "description": "Add scheduled events to the calendar.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.post_calendar_events" + }, + "path": [ + { + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "Id", + "namespace": "_types" } - }, + } + } + ], + "query": [], + "specLocation": "ml/post_calendar_events/MlPostCalendarEventsRequest.ts#L24-L48" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "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.", - "name": "query", - "required": false, - "serverDefault": "{\"match_all\": {\"boost\": 1}}", + "name": "events", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CalendarEvent", + "namespace": "ml._types" + } } } - }, + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.post_calendar_events" + }, + "specLocation": "ml/post_calendar_events/MlPostCalendarEventsResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ { - "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.", - "name": "query_delay", + "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.", + "docId": "put-dfanalytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics", + "name": "config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "DataframePreviewConfig", + "namespace": "ml.preview_data_frame_analytics" } } - }, - { - "description": "Specifies runtime fields for the datafeed search.", - "name": "runtime_mappings", - "required": false, + } + ] + }, + "description": "Preview features used by data frame analytics.\nPreview the extracted features used by a data frame analytics config.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.preview_data_frame_analytics" + }, + "path": [ + { + "description": "Identifier for the data frame analytics job.", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "RuntimeFields", - "namespace": "_types.mapping" - } + "name": "Id", + "namespace": "_types" } - }, + } + } + ], + "query": [], + "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts#L24-L60" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "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.", - "name": "script_fields", - "required": false, + "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.", + "name": "feature_values", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { - "kind": "instance_of", - "type": { - "name": "ScriptField", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } - }, + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.preview_data_frame_analytics" + }, + "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ { - "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`, which is 10,000 by default.", - "name": "scroll_size", + "description": "The datafeed definition to preview.", + "name": "datafeed_config", "required": false, - "serverDefault": 1000, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "DatafeedConfig", + "namespace": "ml._types" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "8.0.0" - } - }, - "name": "headers", + "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.", + "name": "job_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HttpHeaders", - "namespace": "_types" + "name": "JobConfig", + "namespace": "ml._types" } } } ] }, - "description": "Create a datafeed.\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay') at each interval.\nBy default, the datafeed uses the following query: `{\"match_all\": {\"boost\": 1}}`.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", + "description": "Preview a datafeed.\nThis API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", "inherits": { "type": { "name": "RequestBase", @@ -33006,13 +33603,13 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_datafeed" + "namespace": "ml.preview_datafeed" }, "path": [ { - "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.", + "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.", "name": "datafeed_id", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -33024,254 +33621,161 @@ ], "query": [ { - "description": "If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all`\nstring or when no indices are specified.", - "name": "allow_no_indices", + "description": "The start time from where the datafeed preview should begin", + "name": "start", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "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.", - "name": "expand_wildcards", + "description": "The end time when the datafeed preview should stop", + "name": "end", "required": false, - "serverDefault": "open", "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "DateTime", "namespace": "_types" } } - }, - { - "deprecation": { - "description": "", - "version": "7.16.0" - }, - "description": "If true, concrete, expanded, or aliased indices are ignored when frozen.", - "name": "ignore_throttled", - "required": false, - "serverDefault": true, - "type": { + } + ], + "specLocation": "ml/preview_datafeed/MlPreviewDatafeedRequest.ts#L26-L81" + }, + { + "body": { + "codegenName": "documents", + "kind": "value", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "TDocument", + "namespace": "ml.preview_datafeed.Response" } } - }, + } + }, + "generics": [ { - "description": "If true, unavailable indices (missing or closed) are ignored.", - "name": "ignore_unavailable", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "TDocument", + "namespace": "ml.preview_datafeed.Response" } ], - "specLocation": "ml/put_datafeed/MlPutDatafeedRequest.ts#L37-L184" + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.preview_datafeed" + }, + "specLocation": "ml/preview_datafeed/MlPreviewDatafeedResponse.ts#L20-L23" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], "body": { "kind": "properties", "properties": [ { - "name": "aggregations", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" - } - } - } - }, - { - "name": "authorization", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DatafeedAuthorization", - "namespace": "ml._types" - } - } - }, - { - "name": "chunking_config", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ChunkingConfig", - "namespace": "ml._types" - } - } - }, - { - "name": "delayed_data_check_config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DelayedDataCheckConfig", - "namespace": "ml._types" - } - } - }, - { - "name": "datafeed_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "frequency", + "description": "An array of anomaly detection job identifiers.", + "name": "job_ids", "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "indices", - "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } } }, { - "name": "job_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "indices_options", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndicesOptions", - "namespace": "_types" - } - } - }, - { - "name": "max_empty_searches", + "description": "A description of the calendar.", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, - { - "name": "query", - "required": true, + } + ] + }, + "description": "Create a calendar.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.put_calendar" + }, + "path": [ + { + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } + "name": "Id", + "namespace": "_types" } - }, + } + } + ], + "query": [], + "specLocation": "ml/put_calendar/MlPutCalendarRequest.ts#L23-L51" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "name": "query_delay", + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "Id", "namespace": "_types" } } }, { - "name": "runtime_mappings", + "description": "A description of the calendar.", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RuntimeFields", - "namespace": "_types.mapping" - } - } - }, - { - "name": "script_fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ScriptField", - "namespace": "_types" - } + "name": "string", + "namespace": "_builtins" } } }, { - "name": "scroll_size", + "description": "A list of anomaly detection job identifiers or group names.", + "name": "job_ids", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Ids", "namespace": "_types" } } @@ -33281,47 +33785,18 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.put_datafeed" + "namespace": "ml.put_calendar" }, - "specLocation": "ml/put_datafeed/MlPutDatafeedResponse.ts#L31-L49" + "specLocation": "ml/put_calendar/MlPutCalendarResponse.ts#L22-L31" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "description": "A description of the filter.", - "name": "description", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.\nUp to 10000 items are allowed in each filter.", - "name": "items", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - } - ] + "kind": "no_body" }, - "description": "Create a filter.\nA filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects.", + "description": "Add anomaly detection job to calendar.", "inherits": { "type": { "name": "RequestBase", @@ -33331,12 +33806,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_filter" + "namespace": "ml.put_calendar_job" }, "path": [ { - "description": "A string that uniquely identifies a filter.", - "name": "filter_id", + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", "required": true, "type": { "kind": "instance_of", @@ -33345,48 +33820,60 @@ "namespace": "_types" } } + }, + { + "description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.", + "name": "job_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Ids", + "namespace": "_types" + } + } } ], "query": [], - "specLocation": "ml/put_filter/MlPutFilterRequest.ts#L23-L58" + "specLocation": "ml/put_calendar_job/MlPutCalendarJobRequest.ts#L23-L45" }, { "body": { "kind": "properties", "properties": [ { - "name": "description", + "description": "A string that uniquely identifies a calendar.", + "name": "calendar_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "name": "filter_id", - "required": true, + "description": "A description of the calendar.", + "name": "description", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "items", + "description": "A list of anomaly detection job identifiers or group names.", + "name": "job_ids", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "Ids", + "namespace": "_types" } } } @@ -33395,9 +33882,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.put_filter" + "namespace": "ml.put_calendar_job" }, - "specLocation": "ml/put_filter/MlPutFilterResponse.ts#L22-L28" + "specLocation": "ml/put_calendar_job/MlPutCalendarJobResponse.ts#L22-L31" }, { "attachedBehaviors": [ @@ -33407,8 +33894,10 @@ "kind": "properties", "properties": [ { - "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. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", - "name": "allow_lazy_open", + "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node. If\nset to `false` and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to `true`,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.", + "docId": "ml-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "name": "allow_lazy_start", "required": false, "serverDefault": false, "type": { @@ -33420,94 +33909,82 @@ } }, { - "description": "Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.", - "name": "analysis_config", + "description": "The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.", + "name": "analysis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AnalysisConfig", + "name": "DataframeAnalysisContainer", "namespace": "ml._types" } } }, { - "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.", - "name": "analysis_limits", + "description": "Specifies `includes` and/or `excludes` patterns to select which fields\nwill be included in the analysis. The patterns specified in `excludes`\nare applied last, therefore `excludes` takes precedence. In other words,\nif the same field is specified in both `includes` and `excludes`, then\nthe field will not be included in the analysis. If `analyzed_fields` is\nnot set, only the relevant fields will be included. For example, all the\nnumeric fields for outlier detection.\nThe supported fields vary for each type of analysis. Outlier detection\nrequires numeric or `boolean` data to analyze. The algorithms don’t\nsupport missing values therefore fields that have data types other than\nnumeric or boolean are ignored. Documents where included fields contain\nmissing values, null values, or an array are also ignored. Therefore the\n`dest` index may contain documents that don’t have an outlier score.\nRegression supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the regression analysis.\nClassification supports fields that are numeric, `boolean`, `text`,\n`keyword`, and `ip` data types. It is also tolerant of missing values.\nFields that are supported are included in the analysis, other fields are\nignored. Documents where included fields contain an array with two or\nmore values are also ignored. Documents in the `dest` index that don’t\ncontain a results field are not included in the classification analysis.\nClassification analysis can be improved by mapping ordinal variable\nvalues to a single number. For example, in case of age ranges, you can\nmodel the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on.", + "name": "analyzed_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "AnalysisLimits", + "name": "DataframeAnalysisAnalyzedFields", "namespace": "ml._types" } } }, { - "description": "Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low.", - "name": "background_persist_interval", + "description": "A description of the job.", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Advanced configuration option. Contains custom meta data about the job.", - "name": "custom_settings", - "required": false, + "description": "The destination configuration.", + "name": "dest", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CustomSettings", + "name": "DataframeAnalyticsDestination", "namespace": "ml._types" } } }, { - "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", - "name": "daily_model_snapshot_retention_after_days", + "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.", + "name": "max_num_threads", "required": false, "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "description": "Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.", - "name": "data_description", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataDescription", - "namespace": "ml._types" - } - } - }, - { - "description": "Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.", - "name": "datafeed_config", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DatafeedConfig", - "namespace": "ml._types" + "name": "Metadata", + "namespace": "_types" } } }, { - "description": "A description of the job.", - "name": "description", + "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.", + "name": "model_memory_limit", "required": false, + "serverDefault": "1gb", "type": { "kind": "instance_of", "type": { @@ -33517,103 +33994,54 @@ } }, { - "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", - "name": "job_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "A list of job groups. A job can belong to no groups or many.", - "name": "groups", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced.", - "name": "model_plot_config", - "required": false, + "description": "The configuration of how to source the analysis data.", + "name": "source", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ModelPlotConfig", + "name": "DataframeAnalyticsSource", "namespace": "ml._types" } } }, { - "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", - "name": "model_snapshot_retention_days", - "required": false, - "serverDefault": 10, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "availability": { + "serverless": {}, + "stack": { + "since": "8.0.0" } - } - }, - { - "description": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans.", - "name": "renormalization_window_days", + }, + "name": "headers", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "HttpHeaders", "namespace": "_types" } } }, { - "description": "A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`.", - "name": "results_index_name", - "required": false, - "serverDefault": "shared", - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" } - } - }, - { - "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If 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. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.", - "name": "results_retention_days", + }, + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "VersionString", "namespace": "_types" } } } ] }, - "description": "Create an anomaly detection job.\n\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", - "examples": { - "MlPutJobRequestExample1": { - "description": "A request to create an anomaly detection job and datafeed.", - "value": "{\n \"analysis_config\": {\n \"bucket_span\": \"15m\",\n \"detectors\": [\n {\n \"detector_description\": \"Sum of bytes\",\n \"function\": \"sum\",\n \"field_name\": \"bytes\"\n }\n ]\n },\n \"data_description\": {\n \"time_field\": \"timestamp\",\n \"time_format\": \"epoch_ms\"\n },\n \"analysis_limits\": {\n \"model_memory_limit\": \"11MB\"\n },\n \"model_plot_config\": {\n \"enabled\": true,\n \"annotations_enabled\": true\n },\n \"results_index_name\": \"test-job1\",\n \"datafeed_config\": {\n \"indices\": [\n \"kibana_sample_data_logs\"\n ],\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"match_all\": {}\n }\n ]\n }\n },\n \"runtime_mappings\": {\n \"hour_of_day\": {\n \"type\": \"long\",\n \"script\": {\n \"source\": \"emit(doc['timestamp'].value.getHour());\"\n }\n }\n },\n \"datafeed_id\": \"datafeed-test-job1\"\n }\n}" - } - }, + "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.\nBy default, the query used in the source configuration is `{\"match_all\": {}}`.\n\nIf the destination index does not exist, it is created automatically when you start the job.\n\nIf you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.", "inherits": { "type": { "name": "RequestBase", @@ -33623,12 +34051,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_job" + "namespace": "ml.put_data_frame_analytics" }, "path": [ { - "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", - "name": "job_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.", + "name": "id", "required": true, "type": { "kind": "instance_of", @@ -33639,169 +34067,77 @@ } } ], - "query": [ - { - "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.", - "name": "allow_no_indices", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "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. Valid values are:\n\n* `all`: Match any data stream or index, including hidden ones.\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 patterns are not accepted.\n* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.", - "name": "expand_wildcards", - "required": false, - "serverDefault": "open", - "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" - } - } - }, - { - "deprecation": { - "description": "", - "version": "7.16.0" - }, - "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", - "name": "ignore_throttled", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true`, unavailable indices (missing or closed) are ignored.", - "name": "ignore_unavailable", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L157" + "query": [], + "specLocation": "ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts#L30-L155" }, { "body": { "kind": "properties", "properties": [ { - "name": "allow_lazy_open", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "analysis_config", - "required": true, + "name": "authorization", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "AnalysisConfigRead", + "name": "DataframeAnalyticsAuthorization", "namespace": "ml._types" } } }, { - "name": "analysis_limits", + "name": "allow_lazy_start", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AnalysisLimits", - "namespace": "ml._types" - } - } - }, - { - "name": "background_persist_interval", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "create_time", + "name": "analysis", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "DataframeAnalysisContainer", + "namespace": "ml._types" } } }, { - "name": "custom_settings", + "name": "analyzed_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CustomSettings", + "name": "DataframeAnalysisAnalyzedFields", "namespace": "ml._types" } } }, { - "name": "daily_model_snapshot_retention_after_days", + "name": "create_time", "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "long", + "name": "EpochTime", "namespace": "_types" } } }, - { - "name": "data_description", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataDescription", - "namespace": "ml._types" - } - } - }, - { - "name": "datafeed_config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Datafeed", - "namespace": "ml._types" - } - } - }, { "name": "description", "required": false, @@ -33814,132 +34150,90 @@ } }, { - "name": "groups", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "job_id", + "name": "dest", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "DataframeAnalyticsDestination", + "namespace": "ml._types" } } }, { - "name": "job_type", + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "name": "job_version", + "name": "max_num_threads", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "model_plot_config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ModelPlotConfig", - "namespace": "ml._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "model_snapshot_id", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Metadata", "namespace": "_types" } } }, { - "name": "model_snapshot_retention_days", + "name": "model_memory_limit", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "renormalization_window_days", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "results_index_name", + "name": "source", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DataframeAnalyticsSource", + "namespace": "ml._types" } } }, { - "name": "results_retention_days", - "required": false, + "name": "version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "VersionString", "namespace": "_types" } } } ] }, - "examples": { - "MlPutJobResponseExample1": { - "description": "A successful response when creating an anomaly detection job and datafeed.", - "value": "{\n \"job_id\": \"test-job1\",\n \"job_type\": \"anomaly_detector\",\n \"job_version\": \"8.4.0\",\n \"create_time\": 1656087283340,\n \"datafeed_config\": {\n \"datafeed_id\": \"datafeed-test-job1\",\n \"job_id\": \"test-job1\",\n \"authorization\": {\n \"roles\": [\n \"superuser\"\n ]\n },\n \"query_delay\": \"61499ms\",\n \"chunking_config\": {\n \"mode\": \"auto\"\n },\n \"indices_options\": {\n \"expand_wildcards\": [\n \"open\"\n ],\n \"ignore_unavailable\": false,\n \"allow_no_indices\": true,\n \"ignore_throttled\": true\n },\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"match_all\": {}\n }\n ]\n }\n },\n \"indices\": [\n \"kibana_sample_data_logs\"\n ],\n \"scroll_size\": 1000,\n \"delayed_data_check_config\": {\n \"enabled\": true\n },\n \"runtime_mappings\": {\n \"hour_of_day\": {\n \"type\": \"long\",\n \"script\": {\n \"source\": \"emit(doc['timestamp'].value.getHour());\"\n }\n }\n }\n },\n \"analysis_config\": {\n \"bucket_span\": \"15m\",\n \"detectors\": [\n {\n \"detector_description\": \"Sum of bytes\",\n \"function\": \"sum\",\n \"field_name\": \"bytes\",\n \"detector_index\": 0\n }\n ],\n \"influencers\": [],\n \"model_prune_window\": \"30d\"\n },\n \"analysis_limits\": {\n \"model_memory_limit\": \"11mb\",\n \"categorization_examples_limit\": 4\n },\n \"data_description\": {\n \"time_field\": \"timestamp\",\n \"time_format\": \"epoch_ms\"\n },\n \"model_plot_config\": {\n \"enabled\": true,\n \"annotations_enabled\": true\n },\n \"model_snapshot_retention_days\": 10,\n \"daily_model_snapshot_retention_after_days\": 1,\n \"results_index_name\": \"custom-test-job1\",\n \"allow_lazy_open\": false\n}" - } - }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.put_job" + "namespace": "ml.put_data_frame_analytics" }, - "specLocation": "ml/put_job/MlPutJobResponse.ts#L29-L52" + "specLocation": "ml/put_data_frame_analytics/MlPutDataFrameAnalyticsResponse.ts#L31-L47" }, { "attachedBehaviors": [ @@ -33949,122 +34243,188 @@ "kind": "properties", "properties": [ { - "description": "The compressed (GZipped and Base64 encoded) inference definition of the\nmodel. If compressed_definition is specified, then definition cannot be\nspecified.", - "name": "compressed_definition", + "aliases": [ + "aggs" + ], + "description": "If set, the datafeed performs aggregation searches.\nSupport for aggregations is limited and should be used only with low cardinality data.", + "name": "aggregations", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AggregationContainer", + "namespace": "_types.aggregations" + } + } + } + }, + { + "description": "Datafeeds might be required to search over long time periods, for several months or years.\nThis search is split into time chunks in order to ensure the load on Elasticsearch is managed.\nChunking configuration controls how the size of these time chunks are calculated;\nit is an advanced configuration option.", + "name": "chunking_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ChunkingConfig", + "namespace": "ml._types" } } }, { - "description": "The inference definition for the model. If definition is specified, then\ncompressed_definition cannot be specified.", - "name": "definition", + "description": "Specifies whether the datafeed checks for missing data and the size of the window.\nThe datafeed can optionally search over indices that have already been read in an effort to determine whether\nany data has subsequently been added to the index. If missing data is found, it is a good indication that the\n`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time.\nThis check runs only on real-time datafeeds.", + "name": "delayed_data_check_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Definition", - "namespace": "ml.put_trained_model" + "name": "DelayedDataCheckConfig", + "namespace": "ml._types" } } }, { - "description": "A human-readable description of the inference trained model.", - "name": "description", + "description": "The interval at which scheduled queries are made while the datafeed runs in real time.\nThe default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible\nfraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last\n(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses\naggregations, this value must be divisible by the interval of the date histogram aggregation.", + "name": "frequency", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "description": "The default configuration for inference. This can be either a regression\nor classification configuration. It must match the underlying\ndefinition.trained_model's target_type. For pre-packaged models such as\nELSER the config is not required.", - "name": "inference_config", + "aliases": [ + "indexes" + ], + "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master\nnodes and the machine learning nodes must have the `remote_cluster_client` role.", + "name": "indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "InferenceConfigCreateContainer", - "namespace": "ml._types" + "name": "Indices", + "namespace": "_types" } } }, { - "description": "The input field names for the model definition.", - "name": "input", + "description": "Specifies index expansion options that are used during search", + "name": "indices_options", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Input", - "namespace": "ml.put_trained_model" + "name": "IndicesOptions", + "namespace": "_types" } } }, { - "description": "An object map that contains metadata about the model.", - "name": "metadata", + "description": "Identifier for the anomaly detection job.", + "name": "job_id", "required": false, "type": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } }, { - "description": "The model type.", - "name": "model_type", + "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.", + "name": "max_empty_searches", "required": false, - "serverDefault": "tree_ensemble", "type": { "kind": "instance_of", "type": { - "name": "TrainedModelType", - "namespace": "ml._types" + "name": "integer", + "namespace": "_types" } } }, { - "description": "The estimated memory usage in bytes to keep the trained model in memory.\nThis property is supported only if defer_definition_decompression is true\nor the model definition is not supplied.", - "name": "model_size_bytes", + "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.", + "name": "query", "required": false, + "serverDefault": "{\"match_all\": {\"boost\": 1}}", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "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.", + "name": "query_delay", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", "namespace": "_types" } } }, { - "description": "The platform architecture (if applicable) of the trained mode. If the model\nonly works on one platform, because it is heavily optimized for a particular\nprocessor architecture and OS combination, then this field specifies which.\nThe format of the string must match the platform identifiers used by Elasticsearch,\nso one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`,\nor `windows-x86_64`. For portable models (those that work independent of processor\narchitecture or OS features), leave this field unset.", - "name": "platform_architecture", + "description": "Specifies runtime fields for the datafeed search.", + "name": "runtime_mappings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "RuntimeFields", + "namespace": "_types.mapping" } } }, { - "description": "An array of tags to organize the model.", - "name": "tags", + "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.", + "name": "script_fields", "required": false, "type": { - "kind": "array_of", - "value": { + "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ScriptField", + "namespace": "_types" + } + } + } + }, + { + "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`, which is 10,000 by default.", + "name": "scroll_size", + "required": false, + "serverDefault": 1000, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, @@ -34072,23 +34432,22 @@ "availability": { "serverless": {}, "stack": { - "since": "8.12.0" + "since": "8.0.0" } }, - "description": "Optional prefix strings applied at inference", - "name": "prefix_strings", + "name": "headers", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TrainedModelPrefixStrings", - "namespace": "ml._types" + "name": "HttpHeaders", + "namespace": "_types" } } } ] }, - "description": "Create a trained model.\nEnable you to supply a trained model that is not created by data frame analytics.", + "description": "Create a datafeed.\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay') at each interval.\nBy default, the datafeed uses the following query: `{\"match_all\": {\"boost\": 1}}`.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", "inherits": { "type": { "name": "RequestBase", @@ -34098,12 +34457,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.put_trained_model" + "namespace": "ml.put_datafeed" }, "path": [ { - "description": "The unique identifier of the trained model.", - "name": "model_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.", + "name": "datafeed_id", "required": true, "type": { "kind": "instance_of", @@ -34116,15 +34475,10 @@ ], "query": [ { - "availability": { - "serverless": {}, - "stack": { - "since": "8.0.0" - } - }, - "description": "If set to `true` and a `compressed_definition` is provided,\nthe request defers definition decompression and skips relevant\nvalidations.", - "name": "defer_definition_decompression", + "description": "If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all`\nstring or when no indices are specified.", + "name": "allow_no_indices", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -34134,93 +34488,38 @@ } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "8.8.0" - } - }, - "description": "Whether to wait for all child operations (e.g. model download)\nto complete.", - "name": "wait_for_completion", + "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.", + "name": "expand_wildcards", "required": false, + "serverDefault": "open", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L31-L135" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "TrainedModelConfig", - "namespace": "ml._types" - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.put_trained_model" - }, - "specLocation": "ml/put_trained_model/MlPutTrainedModelResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Create or update a trained model alias.\nA trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.put_trained_model_alias" - }, - "path": [ - { - "description": "The alias to create or update. This value cannot end in numbers.", - "name": "model_alias", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", + "name": "ExpandWildcards", "namespace": "_types" } } }, { - "description": "The identifier for the trained model that the alias refers to.", - "name": "model_id", - "required": true, + "deprecation": { + "description": "", + "version": "7.16.0" + }, + "description": "If true, concrete, expanded, or aliased indices are ignored when frozen.", + "name": "ignore_throttled", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "query": [ + }, { - "description": "Specifies whether the alias gets reassigned to the specified trained\nmodel if it is already assigned to a different model. If the alias is\nalready assigned and this parameter is false, the API returns an error.", - "name": "reassign", + "description": "If true, unavailable indices (missing or closed) are ignored.", + "name": "ignore_unavailable", "required": false, "serverDefault": false, "type": { @@ -34232,140 +34531,91 @@ } } ], - "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts#L23-L74" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.put_trained_model_alias" - }, - "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasResponse.ts#L22-L24" + "specLocation": "ml/put_datafeed/MlPutDatafeedRequest.ts#L37-L184" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], "body": { "kind": "properties", "properties": [ { - "description": "The definition part for the model. Must be a base64 encoded string.", - "name": "definition", - "required": true, + "name": "aggregations", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AggregationContainer", + "namespace": "_types.aggregations" + } + } } }, { - "description": "The total uncompressed definition length in bytes. Not base64 encoded.", - "name": "total_definition_length", - "required": true, + "name": "authorization", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "DatafeedAuthorization", + "namespace": "ml._types" } } }, { - "description": "The total number of parts that will be uploaded. Must be greater than 0.", - "name": "total_parts", + "name": "chunking_config", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "ChunkingConfig", + "namespace": "ml._types" } } - } - ] - }, - "description": "Create part of a trained model definition.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.put_trained_model_definition_part" - }, - "path": [ - { - "description": "The unique identifier of the trained model.", - "name": "model_id", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "delayed_data_check_config", + "required": false, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "DelayedDataCheckConfig", + "namespace": "ml._types" + } } - } - }, - { - "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`.", - "name": "part", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "datafeed_id", + "required": true, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } - } - } - ], - "query": [], - "specLocation": "ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts#L24-L65" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.put_trained_model_definition_part" - }, - "specLocation": "ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "description": "The model vocabulary, which must not be empty.", - "name": "vocabulary", + "name": "frequency", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "name": "indices", "required": true, "type": { "kind": "array_of", @@ -34379,185 +34629,150 @@ } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "8.2.0" + "name": "job_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" } - }, - "description": "The optional model merges if required by the tokenizer.", - "name": "merges", + } + }, + { + "name": "indices_options", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "IndicesOptions", + "namespace": "_types" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "8.9.0" + "name": "max_empty_searches", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } - }, - "description": "The optional vocabulary value scores if required by the tokenizer.", - "name": "scores", + } + }, + { + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "query_delay", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "name": "runtime_mappings", "required": false, "type": { - "kind": "array_of", + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } + } + }, + { + "name": "script_fields", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "double", + "name": "ScriptField", "namespace": "_types" } } } - } - ] - }, - "description": "Create a trained model vocabulary.\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.put_trained_model_vocabulary" - }, - "path": [ - { - "description": "The unique identifier of the trained model.", - "name": "model_id", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "scroll_size", + "required": true, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } - } - ], - "query": [], - "specLocation": "ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts#L24-L68" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } + ] }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.put_trained_model_vocabulary" + "namespace": "ml.put_datafeed" }, - "specLocation": "ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyResponse.ts#L22-L24" + "specLocation": "ml/put_datafeed/MlPutDatafeedResponse.ts#L31-L49" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" - }, - "description": "Reset an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.reset_job" - }, - "path": [ - { - "description": "The ID of the job to reset.", - "name": "job_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "Should this request wait until the operation has completed before\nreturning.", - "name": "wait_for_completion", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", + "kind": "properties", + "properties": [ + { + "description": "A description of the filter.", + "name": "description", + "required": false, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "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.", - "name": "delete_user_annotations", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", + }, + { + "description": "The items of the filter. A wildcard `*` can be used at the beginning or the end of an item.\nUp to 10000 items are allowed in each filter.", + "name": "items", + "required": false, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } } - } - ], - "specLocation": "ml/reset_job/MlResetJobRequest.ts#L23-L65" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.reset_job" - }, - "specLocation": "ml/reset_job/MlResetJobResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" + ] }, - "description": "Start a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", + "description": "Create a filter.\nA filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects.", "inherits": { "type": { "name": "RequestBase", @@ -34567,12 +34782,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.start_data_frame_analytics" + "namespace": "ml.put_filter" }, "path": [ { - "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.", - "name": "id", + "description": "A string that uniquely identifies a filter.", + "name": "filter_id", "required": true, "type": { "kind": "instance_of", @@ -34583,58 +34798,57 @@ } } ], - "query": [ - { - "description": "Controls the amount of time to wait until the data frame analytics job\nstarts.", - "name": "timeout", - "required": false, - "serverDefault": "20s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts#L24-L68" + "query": [], + "specLocation": "ml/put_filter/MlPutFilterRequest.ts#L23-L58" }, { "body": { "kind": "properties", "properties": [ { - "name": "acknowledged", + "name": "description", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "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\".", - "name": "node", + "name": "filter_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "NodeId", + "name": "Id", "namespace": "_types" } } + }, + { + "name": "items", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } } ] }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.start_data_frame_analytics" + "namespace": "ml.put_filter" }, - "specLocation": "ml/start_data_frame_analytics/MlStartDataFrameAnalyticsResponse.ts#L22-L34" + "specLocation": "ml/put_filter/MlPutFilterResponse.ts#L22-L28" }, { "attachedBehaviors": [ @@ -34644,34 +34858,46 @@ "kind": "properties", "properties": [ { - "description": "Refer to the description for the `end` query parameter.", - "name": "end", + "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. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available.", + "name": "allow_lazy_open", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Refer to the description for the `start` query parameter.", - "name": "start", + "description": "Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational.", + "name": "analysis_config", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AnalysisConfig", + "namespace": "ml._types" + } + } + }, + { + "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.", + "name": "analysis_limits", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "AnalysisLimits", + "namespace": "ml._types" } } }, { - "description": "Refer to the description for the `timeout` query parameter.", - "name": "timeout", + "description": "Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low.", + "name": "background_persist_interval", "required": false, - "serverDefault": "20s", "type": { "kind": "instance_of", "type": { @@ -34679,285 +34905,166 @@ "namespace": "_types" } } - } - ] - }, - "description": "Start datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.start_datafeed" - }, - "path": [ - { - "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.", - "name": "datafeed_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "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.", - "name": "end", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Advanced configuration option. Contains custom meta data about the job.", + "name": "custom_settings", + "required": false, "type": { - "name": "DateTime", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "CustomSettings", + "namespace": "ml._types" + } } - } - }, - { - "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.", - "name": "start", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } - }, - { - "description": "Specifies the amount of time to wait until a datafeed starts.", - "name": "timeout", - "required": false, - "serverDefault": "20s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ml/start_datafeed/MlStartDatafeedRequest.ts#L24-L99" - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "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.", - "name": "node", - "required": true, + "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`.", + "name": "daily_model_snapshot_retention_after_days", + "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "NodeIds", + "name": "long", "namespace": "_types" } } }, { - "description": "For a successful response, this value is always `true`. On failure, an exception is returned instead.", - "name": "started", + "description": "Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained.", + "name": "data_description", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DataDescription", + "namespace": "ml._types" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.start_datafeed" - }, - "specLocation": "ml/start_datafeed/MlStartDatafeedResponse.ts#L22-L34" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "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.", - "name": "adaptive_allocations", + "description": "Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.", + "name": "datafeed_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "AdaptiveAllocationsSettings", + "name": "DatafeedConfig", "namespace": "ml._types" } } - } - ] - }, - "description": "Start a trained model deployment.\nIt allocates the model to every machine learning node.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.start_trained_model_deployment" - }, - "path": [ - { - "description": "The unique identifier of the trained model. Currently, only PyTorch models are supported.", - "name": "model_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "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.", - "name": "cache_size", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "A description of the job.", + "name": "description", + "required": false, "type": { - "name": "ByteSize", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "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.", - "name": "number_of_allocations", - "required": false, - "serverDefault": 1, - "type": { - "kind": "instance_of", + }, + { + "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "name": "job_id", + "required": false, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } - } - }, - { - "description": "The deployment priority.", - "name": "priority", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "A list of job groups. A job can belong to no groups or many.", + "name": "groups", + "required": false, "type": { - "name": "TrainingPriority", - "namespace": "ml._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - } - }, - { - "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.", - "name": "queue_capacity", - "required": false, - "serverDefault": 1024, - "type": { - "kind": "instance_of", + }, + { + "description": "This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced.", + "name": "model_plot_config", + "required": false, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "ModelPlotConfig", + "namespace": "ml._types" + } } - } - }, - { - "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.", - "name": "threads_per_allocation", - "required": false, - "serverDefault": 1, - "type": { - "kind": "instance_of", + }, + { + "description": "Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.", + "name": "model_snapshot_retention_days", + "required": false, + "serverDefault": 10, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - }, - { - "description": "Specifies the amount of time to wait for the model to deploy.", - "name": "timeout", - "required": false, - "serverDefault": "20s", - "type": { - "kind": "instance_of", + }, + { + "description": "Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans.", + "name": "renormalization_window_days", + "required": false, "type": { - "name": "Duration", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - }, - { - "description": "Specifies the allocation status to wait for before returning.", - "name": "wait_for", - "required": false, - "serverDefault": "started", - "type": { - "kind": "instance_of", + }, + { + "description": "A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`.", + "name": "results_index_name", + "required": false, + "serverDefault": "shared", "type": { - "name": "DeploymentAllocationState", - "namespace": "ml._types" + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } } - } - } - ], - "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L30-L111" - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "assignment", - "required": true, + "description": "Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If 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. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.", + "name": "results_retention_days", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "TrainedModelAssignment", - "namespace": "ml._types" + "name": "long", + "namespace": "_types" } } } ] }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.start_trained_model_deployment" - }, - "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentResponse.ts#L22-L26" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" + "description": "Create an anomaly detection job.\n\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", + "examples": { + "MlPutJobRequestExample1": { + "description": "A request to create an anomaly detection job and datafeed.", + "value": "{\n \"analysis_config\": {\n \"bucket_span\": \"15m\",\n \"detectors\": [\n {\n \"detector_description\": \"Sum of bytes\",\n \"function\": \"sum\",\n \"field_name\": \"bytes\"\n }\n ]\n },\n \"data_description\": {\n \"time_field\": \"timestamp\",\n \"time_format\": \"epoch_ms\"\n },\n \"analysis_limits\": {\n \"model_memory_limit\": \"11MB\"\n },\n \"model_plot_config\": {\n \"enabled\": true,\n \"annotations_enabled\": true\n },\n \"results_index_name\": \"test-job1\",\n \"datafeed_config\": {\n \"indices\": [\n \"kibana_sample_data_logs\"\n ],\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"match_all\": {}\n }\n ]\n }\n },\n \"runtime_mappings\": {\n \"hour_of_day\": {\n \"type\": \"long\",\n \"script\": {\n \"source\": \"emit(doc['timestamp'].value.getHour());\"\n }\n }\n },\n \"datafeed_id\": \"datafeed-test-job1\"\n }\n}" + } }, - "description": "Stop data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "inherits": { "type": { "name": "RequestBase", @@ -34967,12 +35074,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.stop_data_frame_analytics" + "namespace": "ml.put_job" }, "path": [ { - "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.", - "name": "id", + "description": "The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", @@ -34985,8 +35092,8 @@ ], "query": [ { - "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.", - "name": "allow_no_match", + "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.", + "name": "allow_no_indices", "required": false, "serverDefault": true, "type": { @@ -34998,10 +35105,27 @@ } }, { - "description": "If true, the data frame analytics job is stopped forcefully.", - "name": "force", + "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. Valid values are:\n\n* `all`: Match any data stream or index, including hidden ones.\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 patterns are not accepted.\n* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.", + "name": "expand_wildcards", "required": false, - "serverDefault": false, + "serverDefault": "open", + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "deprecation": { + "description": "", + "version": "7.16.0" + }, + "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", + "name": "ignore_throttled", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -35011,27 +35135,27 @@ } }, { - "description": "Controls the amount of time to wait until the data frame analytics job\nstops. Defaults to 20 seconds.", - "name": "timeout", + "description": "If `true`, unavailable indices (missing or closed) are ignored.", + "name": "ignore_unavailable", "required": false, - "serverDefault": "20s", + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts#L24-L78" + "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L157" }, { "body": { "kind": "properties", "properties": [ { - "name": "stopped", + "name": "allow_lazy_open", "required": true, "type": { "kind": "instance_of", @@ -35040,54 +35164,32 @@ "namespace": "_builtins" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.stop_data_frame_analytics" - }, - "specLocation": "ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsResponse.ts#L20-L22" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "description": "Refer to the description for the `allow_no_match` query parameter.", - "name": "allow_no_match", - "required": false, - "serverDefault": true, + "name": "analysis_config", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "AnalysisConfigRead", + "namespace": "ml._types" } } }, { - "description": "Refer to the description for the `force` query parameter.", - "name": "force", - "required": false, - "serverDefault": false, + "name": "analysis_limits", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "AnalysisLimits", + "namespace": "ml._types" } } }, { - "description": "Refer to the description for the `timeout` query parameter.", - "name": "timeout", + "name": "background_persist_interval", "required": false, - "serverDefault": "20s", "type": { "kind": "instance_of", "type": { @@ -35095,332 +35197,144 @@ "namespace": "_types" } } - } - ] - }, - "description": "Stop datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.stop_datafeed" - }, - "path": [ - { - "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.", - "name": "datafeed_id", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "create_time", + "required": true, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } } - } - } - ], - "query": [ - { - "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.", - "name": "allow_no_match", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", + }, + { + "name": "custom_settings", + "required": false, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "CustomSettings", + "namespace": "ml._types" + } } - } - }, - { - "description": "If `true`, the datafeed is stopped forcefully.", - "name": "force", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", + }, + { + "name": "daily_model_snapshot_retention_after_days", + "required": true, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - }, - { - "description": "Specifies the amount of time to wait until a datafeed stops.", - "name": "timeout", - "required": false, - "serverDefault": "20s", - "type": { - "kind": "instance_of", + }, + { + "name": "data_description", + "required": true, "type": { - "name": "Duration", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "DataDescription", + "namespace": "ml._types" + } } - } - } - ], - "specLocation": "ml/stop_datafeed/MlStopDatafeedRequest.ts#L24-L86" - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "stopped", - "required": true, + "name": "datafeed_config", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.stop_datafeed" - }, - "specLocation": "ml/stop_datafeed/MlStopDatafeedResponse.ts#L20-L22" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Stop a trained model deployment.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.stop_trained_model_deployment" - }, - "path": [ - { - "description": "The unique identifier of the trained model.", - "name": "model_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "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.", - "name": "allow_no_match", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "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.", - "name": "force", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts#L23-L61" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "stopped", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "ml.stop_trained_model_deployment" - }, - "specLocation": "ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentResponse.ts#L20-L22" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "A description of the job.", - "name": "description", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", + "name": "Datafeed", + "namespace": "ml._types" + } + } + }, + { + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", "namespace": "_builtins" } } }, { - "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.", - "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", - "name": "model_memory_limit", + "name": "groups", "required": false, - "serverDefault": "1gb", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "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.", - "name": "max_num_threads", - "required": false, - "serverDefault": 1, + "name": "job_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } }, { - "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", - "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", - "name": "allow_lazy_start", - "required": false, - "serverDefault": false, + "name": "job_type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - } - ] - }, - "description": "Update a data frame analytics job.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "ml.update_data_frame_analytics" - }, - "path": [ - { - "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.", - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts#L24-L80" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "authorization", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsAuthorization", - "namespace": "ml._types" - } - } }, { - "name": "allow_lazy_start", + "name": "job_version", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "analysis", - "required": true, + "name": "model_plot_config", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisContainer", + "name": "ModelPlotConfig", "namespace": "ml._types" } } }, { - "name": "analyzed_fields", + "name": "model_snapshot_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataframeAnalysisAnalyzedFields", - "namespace": "ml._types" + "name": "Id", + "namespace": "_types" } } }, { - "name": "create_time", + "name": "model_snapshot_retention_days", "required": true, "type": { "kind": "instance_of", @@ -35431,51 +35345,18 @@ } }, { - "name": "description", + "name": "renormalization_window_days", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "dest", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsDestination", - "namespace": "ml._types" - } - } - }, - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "max_num_threads", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "model_memory_limit", + "name": "results_index_name", "required": true, "type": { "kind": "instance_of", @@ -35486,35 +35367,30 @@ } }, { - "name": "source", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataframeAnalyticsSource", - "namespace": "ml._types" - } - } - }, - { - "name": "version", - "required": true, + "name": "results_retention_days", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "long", "namespace": "_types" } } } ] }, + "examples": { + "MlPutJobResponseExample1": { + "description": "A successful response when creating an anomaly detection job and datafeed.", + "value": "{\n \"job_id\": \"test-job1\",\n \"job_type\": \"anomaly_detector\",\n \"job_version\": \"8.4.0\",\n \"create_time\": 1656087283340,\n \"datafeed_config\": {\n \"datafeed_id\": \"datafeed-test-job1\",\n \"job_id\": \"test-job1\",\n \"authorization\": {\n \"roles\": [\n \"superuser\"\n ]\n },\n \"query_delay\": \"61499ms\",\n \"chunking_config\": {\n \"mode\": \"auto\"\n },\n \"indices_options\": {\n \"expand_wildcards\": [\n \"open\"\n ],\n \"ignore_unavailable\": false,\n \"allow_no_indices\": true,\n \"ignore_throttled\": true\n },\n \"query\": {\n \"bool\": {\n \"must\": [\n {\n \"match_all\": {}\n }\n ]\n }\n },\n \"indices\": [\n \"kibana_sample_data_logs\"\n ],\n \"scroll_size\": 1000,\n \"delayed_data_check_config\": {\n \"enabled\": true\n },\n \"runtime_mappings\": {\n \"hour_of_day\": {\n \"type\": \"long\",\n \"script\": {\n \"source\": \"emit(doc['timestamp'].value.getHour());\"\n }\n }\n }\n },\n \"analysis_config\": {\n \"bucket_span\": \"15m\",\n \"detectors\": [\n {\n \"detector_description\": \"Sum of bytes\",\n \"function\": \"sum\",\n \"field_name\": \"bytes\",\n \"detector_index\": 0\n }\n ],\n \"influencers\": [],\n \"model_prune_window\": \"30d\"\n },\n \"analysis_limits\": {\n \"model_memory_limit\": \"11mb\",\n \"categorization_examples_limit\": 4\n },\n \"data_description\": {\n \"time_field\": \"timestamp\",\n \"time_format\": \"epoch_ms\"\n },\n \"model_plot_config\": {\n \"enabled\": true,\n \"annotations_enabled\": true\n },\n \"model_snapshot_retention_days\": 10,\n \"daily_model_snapshot_retention_after_days\": 1,\n \"results_index_name\": \"custom-test-job1\",\n \"allow_lazy_open\": false\n}" + } + }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.update_data_frame_analytics" + "namespace": "ml.put_job" }, - "specLocation": "ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsResponse.ts#L30-L45" + "specLocation": "ml/put_job/MlPutJobResponse.ts#L29-L52" }, { "attachedBehaviors": [ @@ -35524,193 +35400,146 @@ "kind": "properties", "properties": [ { - "description": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only\nwith low cardinality data.", - "name": "aggregations", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" - } - } - } - }, - { - "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.", - "name": "chunking_config", + "description": "The compressed (GZipped and Base64 encoded) inference definition of the\nmodel. If compressed_definition is specified, then definition cannot be\nspecified.", + "name": "compressed_definition", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ChunkingConfig", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "delayed_data_check_config", + "description": "The inference definition for the model. If definition is specified, then\ncompressed_definition cannot be specified.", + "name": "definition", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DelayedDataCheckConfig", - "namespace": "ml._types" + "name": "Definition", + "namespace": "ml.put_trained_model" } } }, { - "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.", - "name": "frequency", + "description": "A human-readable description of the inference trained model.", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "aliases": [ - "indexes" - ], - "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.", - "name": "indices", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Specifies index expansion options that are used during search.", - "name": "indices_options", + "description": "The default configuration for inference. This can be either a regression\nor classification configuration. It must match the underlying\ndefinition.trained_model's target_type. For pre-packaged models such as\nELSER the config is not required.", + "name": "inference_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndicesOptions", - "namespace": "_types" + "name": "InferenceConfigCreateContainer", + "namespace": "ml._types" } } }, { - "name": "job_id", + "description": "The input field names for the model definition.", + "name": "input", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "Input", + "namespace": "ml.put_trained_model" } } }, { - "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.", - "name": "max_empty_searches", + "description": "An object map that contains metadata about the model.", + "name": "metadata", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "user_defined_value" } }, { - "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.", - "name": "query", + "description": "The model type.", + "name": "model_type", "required": false, - "serverDefault": "{\"match_all\": {\"boost\": 1}}", + "serverDefault": "tree_ensemble", "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "TrainedModelType", + "namespace": "ml._types" } } }, { - "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.", - "name": "query_delay", + "description": "The estimated memory usage in bytes to keep the trained model in memory.\nThis property is supported only if defer_definition_decompression is true\nor the model definition is not supplied.", + "name": "model_size_bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } }, { - "description": "Specifies runtime fields for the datafeed search.", - "name": "runtime_mappings", + "description": "The platform architecture (if applicable) of the trained mode. If the model\nonly works on one platform, because it is heavily optimized for a particular\nprocessor architecture and OS combination, then this field specifies which.\nThe format of the string must match the platform identifiers used by Elasticsearch,\nso one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`,\nor `windows-x86_64`. For portable models (those that work independent of processor\narchitecture or OS features), leave this field unset.", + "name": "platform_architecture", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RuntimeFields", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "script_fields", + "description": "An array of tags to organize the model.", + "name": "tags", "required": false, "type": { - "key": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ScriptField", - "namespace": "_types" - } } } }, { - "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`.", - "name": "scroll_size", + "availability": { + "serverless": {}, + "stack": { + "since": "8.12.0" + } + }, + "description": "Optional prefix strings applied at inference", + "name": "prefix_strings", "required": false, - "serverDefault": 1000, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TrainedModelPrefixStrings", + "namespace": "ml._types" } } } ] }, - "description": "Update a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", + "description": "Create a trained model.\nEnable you to supply a trained model that is not created by data frame analytics.", "inherits": { "type": { "name": "RequestBase", @@ -35720,12 +35549,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.update_datafeed" + "namespace": "ml.put_trained_model" }, "path": [ { - "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.", - "name": "datafeed_id", + "description": "The unique identifier of the trained model.", + "name": "model_id", "required": true, "type": { "kind": "instance_of", @@ -35738,10 +35567,15 @@ ], "query": [ { - "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.", - "name": "allow_no_indices", + "availability": { + "serverless": {}, + "stack": { + "since": "8.0.0" + } + }, + "description": "If set to `true` and a `compressed_definition` is provided,\nthe request defers definition decompression and skips relevant\nvalidations.", + "name": "defer_definition_decompression", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -35751,27 +35585,15 @@ } }, { - "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. Valid values are:\n\n* `all`: Match any data stream or index, including hidden ones.\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 patterns are not accepted.\n* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.", - "name": "expand_wildcards", - "required": false, - "serverDefault": "open", - "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "availability": { + "serverless": {}, + "stack": { + "since": "8.8.0" } - } - }, - { - "deprecation": { - "description": "", - "version": "7.16.0" }, - "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", - "name": "ignore_throttled", + "description": "Whether to wait for all child operations (e.g. model download)\nto complete.", + "name": "wait_for_completion", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -35779,225 +35601,211 @@ "namespace": "_builtins" } } - }, - { - "description": "If `true`, unavailable indices (missing or closed) are ignored.", - "name": "ignore_unavailable", - "required": false, - "serverDefault": false, + } + ], + "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L31-L135" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "name": "TrainedModelConfig", + "namespace": "ml._types" } } - ], - "specLocation": "ml/update_datafeed/MlUpdateDatafeedRequest.ts#L31-L170" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.put_trained_model" + }, + "specLocation": "ml/put_trained_model/MlPutTrainedModelResponse.ts#L22-L24" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], "body": { - "kind": "properties", - "properties": [ - { - "name": "authorization", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DatafeedAuthorization", - "namespace": "ml._types" - } - } - }, - { - "name": "aggregations", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationContainer", - "namespace": "_types.aggregations" - } - } - } - }, - { - "name": "chunking_config", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ChunkingConfig", - "namespace": "ml._types" - } - } - }, - { - "name": "delayed_data_check_config", - "required": false, + "kind": "no_body" + }, + "description": "Create or update a trained model alias.\nA trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.put_trained_model_alias" + }, + "path": [ + { + "description": "The alias to create or update. This value cannot end in numbers.", + "name": "model_alias", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "DelayedDataCheckConfig", - "namespace": "ml._types" - } + "name": "Name", + "namespace": "_types" } - }, - { - "name": "datafeed_id", - "required": true, + } + }, + { + "description": "The identifier for the trained model that the alias refers to.", + "name": "model_id", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "name": "Id", + "namespace": "_types" } - }, - { - "name": "frequency", - "required": false, + } + } + ], + "query": [ + { + "description": "Specifies whether the alias gets reassigned to the specified trained\nmodel if it is already assigned to a different model. If the alias is\nalready assigned and this parameter is false, the API returns an error.", + "name": "reassign", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } + "name": "boolean", + "namespace": "_builtins" } - }, + } + } + ], + "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts#L23-L74" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.put_trained_model_alias" + }, + "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ { - "name": "indices", + "description": "The definition part for the model. Must be a base64 encoded string.", + "name": "definition", "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "indices_options", - "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndicesOptions", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "job_id", + "description": "The total uncompressed definition length in bytes. Not base64 encoded.", + "name": "total_definition_length", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "max_empty_searches", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "query", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "query_delay", + "description": "The total number of parts that will be uploaded. Must be greater than 0.", + "name": "total_parts", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } - }, - { - "name": "runtime_mappings", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RuntimeFields", - "namespace": "_types.mapping" - } - } - }, - { - "name": "script_fields", - "required": false, + } + ] + }, + "description": "Create part of a trained model definition.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.put_trained_model_definition_part" + }, + "path": [ + { + "description": "The unique identifier of the trained model.", + "name": "model_id", + "required": true, + "type": { + "kind": "instance_of", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ScriptField", - "namespace": "_types" - } - } + "name": "Id", + "namespace": "_types" } - }, - { - "name": "scroll_size", - "required": true, + } + }, + { + "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`.", + "name": "part", + "required": true, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "integer", + "namespace": "_types" } } - ] + } + ], + "query": [], + "specLocation": "ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts#L24-L65" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.update_datafeed" + "namespace": "ml.put_trained_model_definition_part" }, - "specLocation": "ml/update_datafeed/MlUpdateDatafeedResponse.ts#L31-L49" + "specLocation": "ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -36007,9 +35815,9 @@ "kind": "properties", "properties": [ { - "description": "The items to add to the filter.", - "name": "add_items", - "required": false, + "description": "The model vocabulary, which must not be empty.", + "name": "vocabulary", + "required": true, "type": { "kind": "array_of", "value": { @@ -36022,35 +35830,50 @@ } }, { - "description": "A description for the filter.", - "name": "description", + "availability": { + "serverless": {}, + "stack": { + "since": "8.2.0" + } + }, + "description": "The optional model merges if required by the tokenizer.", + "name": "merges", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "The items to remove from the filter.", - "name": "remove_items", + "availability": { + "serverless": {}, + "stack": { + "since": "8.9.0" + } + }, + "description": "The optional vocabulary value scores if required by the tokenizer.", + "name": "scores", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } } } ] }, - "description": "Update a filter.\nUpdates the description of a filter, adds items, or removes items from the list.", + "description": "Create a trained model vocabulary.\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", "inherits": { "type": { "name": "RequestBase", @@ -36060,12 +35883,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.update_filter" + "namespace": "ml.put_trained_model_vocabulary" }, "path": [ { - "description": "A string that uniquely identifies a filter.", - "name": "filter_id", + "description": "The unique identifier of the trained model.", + "name": "model_id", "required": true, "type": { "kind": "instance_of", @@ -36077,56 +35900,192 @@ } ], "query": [], - "specLocation": "ml/update_filter/MlUpdateFilterRequest.ts#L23-L60" + "specLocation": "ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts#L24-L68" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.put_trained_model_vocabulary" + }, + "specLocation": "ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Reset an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.reset_job" + }, + "path": [ + { + "description": "The ID of the job to reset.", + "name": "job_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Should this request wait until the operation has completed before\nreturning.", + "name": "wait_for_completion", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "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.", + "name": "delete_user_annotations", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ml/reset_job/MlResetJobRequest.ts#L23-L65" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.reset_job" + }, + "specLocation": "ml/reset_job/MlResetJobResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Start a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.start_data_frame_analytics" + }, + "path": [ + { + "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.", + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Controls the amount of time to wait until the data frame analytics job\nstarts.", + "name": "timeout", + "required": false, + "serverDefault": "20s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts#L24-L68" }, { "body": { "kind": "properties", "properties": [ { - "name": "description", + "name": "acknowledged", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "filter_id", + "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\".", + "name": "node", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "NodeId", "namespace": "_types" } } - }, - { - "name": "items", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } } ] }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.update_filter" + "namespace": "ml.start_data_frame_analytics" }, - "specLocation": "ml/update_filter/MlUpdateFilterResponse.ts#L22-L28" + "specLocation": "ml/start_data_frame_analytics/MlStartDataFrameAnalyticsResponse.ts#L22-L34" }, { "attachedBehaviors": [ @@ -36136,210 +36095,45 @@ "kind": "properties", "properties": [ { - "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.", - "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", - "name": "allow_lazy_open", + "description": "Refer to the description for the `end` query parameter.", + "name": "end", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "analysis_limits", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "AnalysisMemoryLimit", - "namespace": "ml._types" - } - } - }, - { - "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.", - "name": "background_persist_interval", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "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.", - "docId": "ml.customUrls", - "name": "custom_settings", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "categorization_filters", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "A description of the job.", - "name": "description", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "model_plot_config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ModelPlotConfig", - "namespace": "ml._types" - } - } - }, - { - "name": "model_prune_window", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "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`.", - "docId": "ml-model-snapshots", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots", - "name": "daily_model_snapshot_retention_after_days", - "required": false, - "serverDefault": 1, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "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.", - "docId": "ml-model-snapshots", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots", - "name": "model_snapshot_retention_days", - "required": false, - "serverDefault": 10, - "type": { - "kind": "instance_of", - "type": { - "name": "long", + "name": "DateTime", "namespace": "_types" } } }, { - "description": "Advanced configuration option. The period over which adjustments to the\nscore are applied, as new data is seen.", - "name": "renormalization_window_days", + "description": "Refer to the description for the `start` query parameter.", + "name": "start", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "DateTime", "namespace": "_types" } } }, { - "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.", - "name": "results_retention_days", + "description": "Refer to the description for the `timeout` query parameter.", + "name": "timeout", "required": false, + "serverDefault": "20s", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Duration", "namespace": "_types" } } - }, - { - "description": "A list of job groups. A job can belong to no groups or many.", - "name": "groups", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "An array of detector update objects.", - "name": "detectors", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DetectorUpdate", - "namespace": "ml._types" - } - } - } - }, - { - "description": "Settings related to how categorization interacts with partition fields.", - "name": "per_partition_categorization", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "PerPartitionCategorization", - "namespace": "ml._types" - } - } } ] }, - "description": "Update an anomaly detection job.\nUpdates certain properties of an anomaly detection job.", + "description": "Start datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", "inherits": { "type": { "name": "RequestBase", @@ -36349,12 +36143,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.update_job" + "namespace": "ml.start_datafeed" }, "path": [ { - "description": "Identifier for the job.", - "name": "job_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.", + "name": "datafeed_id", "required": true, "type": { "kind": "instance_of", @@ -36365,284 +36159,83 @@ } } ], - "query": [], - "specLocation": "ml/update_job/MlUpdateJobRequest.ts#L33-L147" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "name": "allow_lazy_open", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "analysis_config", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "AnalysisConfigRead", - "namespace": "ml._types" - } - } - }, - { - "name": "analysis_limits", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "AnalysisLimits", - "namespace": "ml._types" - } - } - }, - { - "name": "background_persist_interval", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "name": "create_time", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - }, - { - "name": "finished_time", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - }, - { - "name": "custom_settings", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "daily_model_snapshot_retention_after_days", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "data_description", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataDescription", - "namespace": "ml._types" - } - } - }, - { - "name": "datafeed_config", - "required": false, + "query": [ + { + "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.", + "name": "end", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "Datafeed", - "namespace": "ml._types" - } + "name": "DateTime", + "namespace": "_types" } - }, - { - "name": "description", - "required": false, + } + }, + { + "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.", + "name": "start", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "DateTime", + "namespace": "_types" } - }, - { - "name": "groups", - "required": false, + } + }, + { + "description": "Specifies the amount of time to wait until a datafeed starts.", + "name": "timeout", + "required": false, + "serverDefault": "20s", + "type": { + "kind": "instance_of", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "Duration", + "namespace": "_types" } - }, + } + } + ], + "specLocation": "ml/start_datafeed/MlStartDatafeedRequest.ts#L24-L99" + }, + { + "body": { + "kind": "properties", + "properties": [ { - "name": "job_id", + "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.", + "name": "node", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "NodeIds", "namespace": "_types" } } }, { - "name": "job_type", + "description": "For a successful response, this value is always `true`. On failure, an exception is returned instead.", + "name": "started", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } - }, - { - "name": "job_version", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" - } - } - }, - { - "name": "model_plot_config", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ModelPlotConfig", - "namespace": "ml._types" - } - } - }, - { - "name": "model_snapshot_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "model_snapshot_retention_days", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "renormalization_window_days", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "results_index_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "results_retention_days", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } } ] }, "kind": "response", "name": { "name": "Response", - "namespace": "ml.update_job" + "namespace": "ml.start_datafeed" }, - "specLocation": "ml/update_job/MlUpdateJobResponse.ts#L29-L53" + "specLocation": "ml/start_datafeed/MlStartDatafeedResponse.ts#L22-L34" }, { "attachedBehaviors": [ @@ -36651,19 +36244,6 @@ "body": { "kind": "properties", "properties": [ - { - "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.", - "name": "number_of_allocations", - "required": false, - "serverDefault": 1, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, { "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.", "name": "adaptive_allocations", @@ -36678,7 +36258,7 @@ } ] }, - "description": "Update a trained model deployment.", + "description": "Start a trained model deployment.\nIt allocates the model to every machine learning node.", "inherits": { "type": { "name": "RequestBase", @@ -36688,7 +36268,7 @@ "kind": "request", "name": { "name": "Request", - "namespace": "ml.update_trained_model_deployment" + "namespace": "ml.start_trained_model_deployment" }, "path": [ { @@ -36706,7 +36286,19 @@ ], "query": [ { - "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.", + "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.", + "name": "cache_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } + }, + { + "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.", "name": "number_of_allocations", "required": false, "serverDefault": 1, @@ -36717,9 +36309,73 @@ "namespace": "_types" } } + }, + { + "description": "The deployment priority.", + "name": "priority", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TrainingPriority", + "namespace": "ml._types" + } + } + }, + { + "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.", + "name": "queue_capacity", + "required": false, + "serverDefault": 1024, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "threads_per_allocation", + "required": false, + "serverDefault": 1, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Specifies the amount of time to wait for the model to deploy.", + "name": "timeout", + "required": false, + "serverDefault": "20s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Specifies the allocation status to wait for before returning.", + "name": "wait_for", + "required": false, + "serverDefault": "started", + "type": { + "kind": "instance_of", + "type": { + "name": "DeploymentAllocationState", + "namespace": "ml._types" + } + } } ], - "specLocation": "ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts#L25-L78" + "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L30-L111" }, { "body": { @@ -36741,29 +36397,18 @@ "kind": "response", "name": { "name": "Response", - "namespace": "ml.update_trained_model_deployment" + "namespace": "ml.start_trained_model_deployment" }, - "specLocation": "ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentResponse.ts#L22-L26" + "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentResponse.ts#L22-L26" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "codegenName": "searches", - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RequestItem", - "namespace": "_global.msearch" - } - } - } + "kind": "no_body" }, - "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", + "description": "Stop data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "inherits": { "type": { "name": "RequestBase", @@ -36773,17 +36418,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "_global.msearch" + "namespace": "ml.stop_data_frame_analytics" }, "path": [ { - "description": "Comma-separated list of data streams, indices, and index aliases to search.", - "name": "index", - "required": false, + "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.", + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Id", "namespace": "_types" } } @@ -36791,9 +36436,10 @@ ], "query": [ { - "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.", - "name": "allow_no_indices", + "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.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -36803,12 +36449,10 @@ } }, { - "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", - "docId": "ccs-network-delays", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html#ccs-network-delays", - "name": "ccs_minimize_roundtrips", + "description": "If true, the data frame analytics job is stopped forcefully.", + "name": "force", "required": false, - "serverDefault": true, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -36818,96 +36462,136 @@ } }, { - "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.", - "name": "expand_wildcards", + "description": "Controls the amount of time to wait until the data frame analytics job\nstops. Defaults to 20 seconds.", + "name": "timeout", "required": false, + "serverDefault": "20s", "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", + "name": "Duration", "namespace": "_types" } } - }, - { - "description": "If true, concrete, expanded or aliased indices are ignored when frozen.", - "name": "ignore_throttled", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", + } + ], + "specLocation": "ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts#L24-L78" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "stopped", + "required": true, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } } - }, - { - "description": "If true, missing or closed indices are not included in the response.", - "name": "ignore_unavailable", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.stop_data_frame_analytics" + }, + "specLocation": "ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsResponse.ts#L20-L22" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Refer to the description for the `allow_no_match` query parameter.", + "name": "allow_no_match", + "required": false, + "serverDefault": true, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - }, - { - "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.", - "name": "include_named_queries_score", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Refer to the description for the `force` query parameter.", + "name": "force", + "required": false, + "serverDefault": false, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - }, - { - "description": "Maximum number of concurrent searches the multi search API can execute.", - "name": "max_concurrent_searches", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "description": "Refer to the description for the `timeout` query parameter.", + "name": "timeout", + "required": false, + "serverDefault": "20s", "type": { - "name": "long", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } } } - }, + ] + }, + "description": "Stop datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "ml.stop_datafeed" + }, + "path": [ { - "description": "Maximum number of concurrent shard requests that each sub-search request executes per node.", - "name": "max_concurrent_shard_requests", - "required": false, - "serverDefault": 5, + "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.", + "name": "datafeed_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "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.", - "name": "pre_filter_shard_size", + "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.", + "name": "allow_no_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.", - "name": "rest_total_hits_as_int", + "description": "If `true`, the datafeed is stopped forcefully.", + "name": "force", "required": false, "serverDefault": false, "type": { @@ -36919,102 +36603,53 @@ } }, { - "description": "Custom routing value used to route search operations to a specific shard.", - "name": "routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Routing", - "namespace": "_types" - } - } - }, - { - "description": "Indicates whether global term and document frequencies should be used when scoring returned documents.", - "name": "search_type", + "description": "Specifies the amount of time to wait until a datafeed stops.", + "name": "timeout", "required": false, + "serverDefault": "20s", "type": { "kind": "instance_of", "type": { - "name": "SearchType", + "name": "Duration", "namespace": "_types" } } - }, - { - "description": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.", - "name": "typed_keys", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } } ], - "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L135" + "specLocation": "ml/stop_datafeed/MlStopDatafeedRequest.ts#L24-L86" }, { "body": { - "kind": "value", - "value": { - "generics": [ - { + "kind": "properties", + "properties": [ + { + "name": "stopped", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "TDocument", - "namespace": "_global.msearch.Response" + "name": "boolean", + "namespace": "_builtins" } } - ], - "kind": "instance_of", - "type": { - "name": "MultiSearchResult", - "namespace": "_global.msearch" } - } + ] }, - "generics": [ - { - "name": "TDocument", - "namespace": "_global.msearch.Response" - } - ], "kind": "response", "name": { "name": "Response", - "namespace": "_global.msearch" + "namespace": "ml.stop_datafeed" }, - "specLocation": "_global/msearch/MultiSearchResponse.ts#L25-L27" + "specLocation": "ml/stop_datafeed/MlStopDatafeedResponse.ts#L20-L22" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "codegenName": "search_templates", - "kind": "value", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RequestItem", - "namespace": "_global.msearch_template" - } - } - } - }, - "description": "Run multiple templated searches.\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```", - "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\" }}" - } + "kind": "no_body" }, + "description": "Stop a trained model deployment.", "inherits": { "type": { "name": "RequestBase", @@ -37024,17 +36659,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "_global.msearch_template" + "namespace": "ml.stop_trained_model_deployment" }, "path": [ { - "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 `*`.", - "name": "index", - "required": false, + "description": "The unique identifier of the trained model.", + "name": "model_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Id", "namespace": "_types" } } @@ -37042,8 +36677,8 @@ ], "query": [ { - "description": "If `true`, network round-trips are minimized for cross-cluster search requests.", - "name": "ccs_minimize_roundtrips", + "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.", + "name": "allow_no_match", "required": false, "serverDefault": true, "type": { @@ -37055,45 +36690,8 @@ } }, { - "description": "The maximum number of concurrent searches the API can run.", - "name": "max_concurrent_searches", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The type of the search operation.", - "name": "search_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SearchType", - "namespace": "_types" - } - } - }, - { - "description": "If `true`, the response returns `hits.total` as an integer.\nIf `false`, it returns `hits.total` as an object.", - "name": "rest_total_hits_as_int", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true`, the response prefixes aggregation and suggester names with their respective types.", - "name": "typed_keys", + "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.", + "name": "force", "required": false, "serverDefault": false, "type": { @@ -37105,40 +36703,31 @@ } } ], - "specLocation": "_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L116" + "specLocation": "ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts#L23-L61" }, { "body": { - "kind": "value", - "value": { - "generics": [ - { + "kind": "properties", + "properties": [ + { + "name": "stopped", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "TDocument", - "namespace": "_global.msearch_template.Response" + "name": "boolean", + "namespace": "_builtins" } } - ], - "kind": "instance_of", - "type": { - "name": "MultiSearchResult", - "namespace": "_global.msearch" } - } + ] }, - "generics": [ - { - "name": "TDocument", - "namespace": "_global.msearch_template.Response" - } - ], "kind": "response", "name": { "name": "Response", - "namespace": "_global.msearch_template" + "namespace": "ml.stop_trained_model_deployment" }, - "specLocation": "_global/msearch_template/MultiSearchTemplateResponse.ts#L22-L31" + "specLocation": "ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentResponse.ts#L20-L22" }, { "attachedBehaviors": [ @@ -37148,55 +36737,63 @@ "kind": "properties", "properties": [ { - "description": "An array of existing or artificial documents.", - "name": "docs", + "description": "A description of the job.", + "name": "description", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Operation", - "namespace": "_global.mtermvectors" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "A simplified syntax to specify documents by their ID if they're in the same index.", - "name": "ids", + "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.", + "docId": "ml-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "name": "model_memory_limit", "required": false, + "serverDefault": "1gb", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "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.", + "name": "max_num_threads", + "required": false, + "serverDefault": 1, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", + "docId": "ml-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "name": "allow_lazy_start", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } ] }, - "description": "Get multiple term vectors.\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`.", - "examples": { - "MultiTermVectorsRequestExample1": { - "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", - "summary": "Get multiple term vectors", - "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": { - "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", - "summary": "Simplified syntax", - "value": "{\n \"ids\": [ \"1\", \"2\" ],\n \"fields\": [\n \"message\"\n ],\n \"term_statistics\": true\n}" - }, - "MultiTermVectorsRequestExample3": { - "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", - "summary": "Artificial documents", - "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}" - } - }, + "description": "Update a data frame analytics job.", "inherits": { "type": { "name": "RequestBase", @@ -37206,196 +36803,158 @@ "kind": "request", "name": { "name": "Request", - "namespace": "_global.mtermvectors" + "namespace": "ml.update_data_frame_analytics" }, "path": [ { - "description": "The name of the index that contains the documents.", - "name": "index", - "required": false, + "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.", + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Id", "namespace": "_types" } } } ], - "query": [ - { - "description": "A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body", - "name": "ids", - "required": false, - "type": { - "kind": "array_of", - "value": { + "query": [], + "specLocation": "ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts#L24-L80" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "authorization", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "DataframeAnalyticsAuthorization", + "namespace": "ml._types" } } - } - }, - { - "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.", - "name": "fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { - "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", - "name": "field_statistics", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", + }, + { + "name": "allow_lazy_start", + "required": true, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - }, - { - "description": "If `true`, the response includes term offsets.", - "name": "offsets", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", + }, + { + "name": "analysis", + "required": true, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "DataframeAnalysisContainer", + "namespace": "ml._types" + } } - } - }, - { - "description": "If `true`, the response includes term payloads.", - "name": "payloads", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", + }, + { + "name": "analyzed_fields", + "required": false, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "DataframeAnalysisAnalyzedFields", + "namespace": "ml._types" + } } - } - }, - { - "description": "If `true`, the response includes term positions.", - "name": "positions", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", + }, + { + "name": "create_time", + "required": true, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - }, - { - "description": "The node or shard the operation should be performed on.\nIt is random by default.", - "name": "preference", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "description", + "required": false, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "description": "If true, the request is real-time as opposed to near-real-time.", - "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", - "name": "realtime", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", + }, + { + "name": "dest", + "required": true, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "DataframeAnalyticsDestination", + "namespace": "ml._types" + } } - } - }, - { - "description": "A custom value used to route operations to a specific shard.", - "name": "routing", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "id", + "required": true, "type": { - "name": "Routing", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } - } - }, - { - "description": "If true, the response includes term frequency and document frequency.", - "name": "term_statistics", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", + }, + { + "name": "max_num_threads", + "required": true, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } - } - }, - { - "description": "If `true`, returns the document version as part of a hit.", - "name": "version", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "model_memory_limit", + "required": true, "type": { - "name": "VersionNumber", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "description": "The version type.", - "name": "version_type", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "source", + "required": true, "type": { - "name": "VersionType", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "DataframeAnalyticsSource", + "namespace": "ml._types" + } } - } - } - ], - "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L134" - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "docs", + "name": "version", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TermVectorsResult", - "namespace": "_global.mtermvectors" - } + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" } } } @@ -37404,9 +36963,9 @@ "kind": "response", "name": { "name": "Response", - "namespace": "_global.mtermvectors" + "namespace": "ml.update_data_frame_analytics" }, - "specLocation": "_global/mtermvectors/MultiTermVectorsResponse.ts#L22-L24" + "specLocation": "ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsResponse.ts#L30-L45" }, { "attachedBehaviors": [ @@ -37416,9 +36975,122 @@ "kind": "properties", "properties": [ { - "description": "Filter indices if the provided query rewrites to `match_none` on every shard.", - "name": "index_filter", + "description": "If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only\nwith low cardinality data.", + "name": "aggregations", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AggregationContainer", + "namespace": "_types.aggregations" + } + } + } + }, + { + "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.", + "name": "chunking_config", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ChunkingConfig", + "namespace": "ml._types" + } + } + }, + { + "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.", + "name": "delayed_data_check_config", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DelayedDataCheckConfig", + "namespace": "ml._types" + } + } + }, + { + "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.", + "name": "frequency", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "indexes" + ], + "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.", + "name": "indices", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "Specifies index expansion options that are used during search.", + "name": "indices_options", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndicesOptions", + "namespace": "_types" + } + } + }, + { + "name": "job_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "max_empty_searches", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "query", "required": false, + "serverDefault": "{\"match_all\": {\"boost\": 1}}", "type": { "kind": "instance_of", "type": { @@ -37426,10 +37098,70 @@ "namespace": "_types.query_dsl" } } + }, + { + "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.", + "name": "query_delay", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Specifies runtime fields for the datafeed search.", + "name": "runtime_mappings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } + } + }, + { + "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.", + "name": "script_fields", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ScriptField", + "namespace": "_types" + } + } + } + }, + { + "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`.", + "name": "scroll_size", + "required": false, + "serverDefault": 1000, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } ] }, - "description": "Open a point in time.\n\nA 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.", + "description": "Update a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", "inherits": { "type": { "name": "RequestBase", @@ -37439,17 +37171,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "_global.open_point_in_time" + "namespace": "ml.update_datafeed" }, "path": [ { - "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", - "name": "index", + "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.", + "name": "datafeed_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Id", "namespace": "_types" } } @@ -37457,22 +37189,10 @@ ], "query": [ { - "description": "Extend the length of time that the point in time persists.", - "name": "keep_alive", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "If `false`, the request returns an error if it targets a missing or closed index.", - "name": "ignore_unavailable", + "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.", + "name": "allow_no_indices", "required": false, - "serverDefault": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -37482,76 +37202,112 @@ } }, { - "description": "The node or shard the operation should be performed on.\nBy default, it is random.", - "name": "preference", + "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. Valid values are:\n\n* `all`: Match any data stream or index, including hidden ones.\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 patterns are not accepted.\n* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.", + "name": "expand_wildcards", "required": false, + "serverDefault": "open", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ExpandWildcards", + "namespace": "_types" } } }, { - "description": "A custom value that is used to route operations to a specific shard.", - "name": "routing", + "deprecation": { + "description": "", + "version": "7.16.0" + }, + "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", + "name": "ignore_throttled", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "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`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.", - "name": "expand_wildcards", + "description": "If `true`, unavailable indices (missing or closed) are ignored.", + "name": "ignore_unavailable", "required": false, - "serverDefault": "open", + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "ExpandWildcards", - "namespace": "_types" - } - } - }, - { - "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.", - "name": "allow_partial_search_results", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "_global/open_point_in_time/OpenPointInTimeRequest.ts#L25-L121" + "specLocation": "ml/update_datafeed/MlUpdateDatafeedRequest.ts#L31-L170" }, { "body": { "kind": "properties", "properties": [ { - "description": "Shards used to create the PIT", - "name": "_shards", + "name": "authorization", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DatafeedAuthorization", + "namespace": "ml._types" + } + } + }, + { + "name": "aggregations", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AggregationContainer", + "namespace": "_types.aggregations" + } + } + } + }, + { + "name": "chunking_config", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", - "namespace": "_types" + "name": "ChunkingConfig", + "namespace": "ml._types" } } }, { - "name": "id", + "name": "delayed_data_check_config", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DelayedDataCheckConfig", + "namespace": "ml._types" + } + } + }, + { + "name": "datafeed_id", "required": true, "type": { "kind": "instance_of", @@ -37560,261 +37316,192 @@ "namespace": "_types" } } - } - ] - }, - "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}" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "_global.open_point_in_time" - }, - "specLocation": "_global/open_point_in_time/OpenPointInTimeResponse.ts#L23-L29" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Ping the cluster.\nGet information about whether the cluster is running.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "_global.ping" - }, - "path": [], - "query": [], - "specLocation": "_global/ping/PingRequest.ts#L22-L38" - }, - { - "body": { - "kind": "no_body" - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "_global.ping" - }, - "specLocation": "_global/ping/PingResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "description": "The script or search template, its parameters, and its language.", - "name": "script", + "name": "frequency", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "name": "indices", "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "indices_options", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "StoredScript", + "name": "IndicesOptions", "namespace": "_types" } } - } - ] - }, - "description": "Create or update a script or search template.\nCreates or updates a stored script or search template.", - "examples": { - "PutScriptRequestExample1": { - "description": "Run `PUT _scripts/my-search-template` to create a search template.\n", - "summary": "Create a search template", - "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": { - "description": "Run `PUT _scripts/my-stored-script` to create a stored script.\n", - "summary": "Create a stored script", - "value": "{\n \"script\": {\n \"lang\": \"painless\",\n \"source\": \"Math.log(_score * 2) + params['my_modifier']\"\n }\n}" - } - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "_global.put_script" - }, - "path": [ - { - "description": "The identifier for the stored script or search template.\nIt must be unique within the cluster.", - "name": "id", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "job_id", + "required": true, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } - } - }, - { - "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.", - "name": "context", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "max_empty_searches", + "required": false, "type": { - "name": "Name", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } - } - } - ], - "query": [ - { - "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.", - "name": "context", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "query", + "required": true, "type": { - "name": "Name", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } } - } - }, - { - "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.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", + }, + { + "name": "query_delay", + "required": true, "type": { - "name": "Duration", - "namespace": "_types" + "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.\nIt can also be set to `-1` to indicate that the request should never timeout.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", + }, + { + "name": "runtime_mappings", + "required": false, "type": { - "name": "Duration", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "RuntimeFields", + "namespace": "_types.mapping" + } + } + }, + { + "name": "script_fields", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ScriptField", + "namespace": "_types" + } + } + } + }, + { + "name": "scroll_size", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } - } - ], - "specLocation": "_global/put_script/PutScriptRequest.ts#L25-L87" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } + ] }, "kind": "response", "name": { "name": "Response", - "namespace": "_global.put_script" + "namespace": "ml.update_datafeed" }, - "specLocation": "_global/put_script/PutScriptResponse.ts#L22-L24" + "specLocation": "ml/update_datafeed/MlUpdateDatafeedResponse.ts#L31-L49" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" - }, - "description": "Delete a query rule.\nDelete 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.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "query_rules.delete_rule" - }, - "path": [ - { - "description": "The unique identifier of the query ruleset containing the rule to delete", - "name": "ruleset_id", - "required": true, - "type": { - "kind": "instance_of", + "kind": "properties", + "properties": [ + { + "description": "The items to add to the filter.", + "name": "add_items", + "required": false, "type": { - "name": "Id", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - } - }, - { - "description": "The unique identifier of the query rule within the specified ruleset to delete", - "name": "rule_id", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "description": "A description for the filter.", + "name": "description", + "required": false, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The items to remove from the filter.", + "name": "remove_items", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } } - } - ], - "query": [], - "specLocation": "query_rules/delete_rule/QueryRuleDeleteRequest.ts#L22-L50" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "query_rules.delete_rule" - }, - "specLocation": "query_rules/delete_rule/QueryRuleDeleteResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" + ] }, - "description": "Delete a query ruleset.\nRemove a query ruleset and its associated data.\nThis is a destructive action that is not recoverable.", + "description": "Update a filter.\nUpdates the description of a filter, adds items, or removes items from the list.", "inherits": { "type": { "name": "RequestBase", @@ -37824,12 +37511,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "query_rules.delete_ruleset" + "namespace": "ml.update_filter" }, "path": [ { - "description": "The unique identifier of the query ruleset to delete", - "name": "ruleset_id", + "description": "A string that uniquely identifies a filter.", + "name": "filter_id", "required": true, "type": { "kind": "instance_of", @@ -37841,435 +37528,269 @@ } ], "query": [], - "specLocation": "query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts#L22-L45" + "specLocation": "ml/update_filter/MlUpdateFilterRequest.ts#L23-L60" }, { "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" + "kind": "properties", + "properties": [ + { + "name": "description", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "filter_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "items", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } } - } + ] }, "kind": "response", "name": { "name": "Response", - "namespace": "query_rules.delete_ruleset" + "namespace": "ml.update_filter" }, - "specLocation": "query_rules/delete_ruleset/QueryRulesetDeleteResponse.ts#L22-L24" + "specLocation": "ml/update_filter/MlUpdateFilterResponse.ts#L22-L28" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "no_body" - }, - "description": "Get a query rule.\nGet details about a query rule within a query ruleset.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "query_rules.get_rule" - }, - "path": [ - { - "description": "The unique identifier of the query ruleset containing the rule to retrieve", - "name": "ruleset_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "The unique identifier of the query rule within the specified ruleset to retrieve", - "name": "rule_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "query_rules/get_rule/QueryRuleGetRequest.ts#L22-L50" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryRule", - "namespace": "query_rules._types" - } - } - }, - "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}" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "query_rules.get_rule" - }, - "specLocation": "query_rules/get_rule/QueryRuleGetResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Get a query ruleset.\nGet details about a query ruleset.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "query_rules.get_ruleset" - }, - "path": [ - { - "description": "The unique identifier of the query ruleset", - "name": "ruleset_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "query_rules/get_ruleset/QueryRulesetGetRequest.ts#L22-L44" - }, - { - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryRuleset", - "namespace": "query_rules._types" - } - } - }, - "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}" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "query_rules.get_ruleset" - }, - "specLocation": "query_rules/get_ruleset/QueryRulesetGetResponse.ts#L22-L24" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Get all query rulesets.\nGet summarized information about the query rulesets.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "query_rules.list_rulesets" - }, - "path": [], - "query": [ - { - "description": "The offset from the first result to fetch.", - "name": "from", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", + "kind": "properties", + "properties": [ + { + "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.", + "docId": "ml-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "name": "allow_lazy_open", + "required": false, + "serverDefault": false, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - }, - { - "description": "The maximum number of results to retrieve.", - "name": "size", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "analysis_limits", + "required": false, "type": { - "name": "integer", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "AnalysisMemoryLimit", + "namespace": "ml._types" + } } - } - } - ], - "specLocation": "query_rules/list_rulesets/QueryRulesetListRequest.ts#L22-L49" - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "count", - "required": true, + "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.", + "name": "background_persist_interval", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Duration", "namespace": "_types" } } }, { - "name": "results", - "required": true, + "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.", + "docId": "ml.customUrls", + "name": "custom_settings", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "name": "categorization_filters", + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "QueryRulesetListItem", - "namespace": "query_rules.list_rulesets" + "name": "string", + "namespace": "_builtins" } } } - } - ] - }, - "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}" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "query_rules.list_rulesets" - }, - "specLocation": "query_rules/list_rulesets/QueryRulesetListResponse.ts#L23-L28" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "description": "The type of rule.", - "name": "type", - "required": true, + "description": "A description of the job.", + "name": "description", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryRuleType", - "namespace": "query_rules._types" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "criteria", - "required": true, + "name": "model_plot_config", + "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "QueryRuleCriteria", - "namespace": "query_rules._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryRuleCriteria", - "namespace": "query_rules._types" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "ModelPlotConfig", + "namespace": "ml._types" + } } }, { - "description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.", - "name": "actions", - "required": true, + "name": "model_prune_window", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryRuleActions", - "namespace": "query_rules._types" + "name": "Duration", + "namespace": "_types" } } }, { - "name": "priority", + "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`.", + "docId": "ml-model-snapshots", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots", + "name": "daily_model_snapshot_retention_after_days", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } - } - ] - }, - "description": "Create or update a query rule.\nCreate 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.", - "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}" - } - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "query_rules.put_rule" - }, - "path": [ - { - "description": "The unique identifier of the query ruleset containing the rule to be created or updated.", - "name": "ruleset_id", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "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.", + "docId": "ml-model-snapshots", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots", + "name": "model_snapshot_retention_days", + "required": false, + "serverDefault": 10, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - }, - { - "description": "The unique identifier of the query rule within the specified ruleset to be created or updated.", - "name": "rule_id", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "description": "Advanced configuration option. The period over which adjustments to the\nscore are applied, as new data is seen.", + "name": "renormalization_window_days", + "required": false, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - } - ], - "query": [], - "specLocation": "query_rules/put_rule/QueryRulePutRequest.ts#L28-L79" - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "result", - "required": true, + "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.", + "name": "results_retention_days", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Result", + "name": "long", "namespace": "_types" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "query_rules.put_rule" - }, - "specLocation": "query_rules/put_rule/QueryRulePutResponse.ts#L22-L26" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "rules", - "required": true, + "description": "A list of job groups. A job can belong to no groups or many.", + "name": "groups", + "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "QueryRule", - "namespace": "query_rules._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryRule", - "namespace": "query_rules._types" - } - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ], - "kind": "union_of" + } + } + }, + { + "description": "An array of detector update objects.", + "name": "detectors", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DetectorUpdate", + "namespace": "ml._types" + } + } + } + }, + { + "description": "Settings related to how categorization interacts with partition fields.", + "name": "per_partition_categorization", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "PerPartitionCategorization", + "namespace": "ml._types" + } } } ] }, - "description": "Create or update a query ruleset.\nThere 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.", - "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}" - } - }, + "description": "Update an anomaly detection job.\nUpdates certain properties of an anomaly detection job.", "inherits": { "type": { "name": "RequestBase", @@ -38279,12 +37800,12 @@ "kind": "request", "name": { "name": "Request", - "namespace": "query_rules.put_ruleset" + "namespace": "ml.update_job" }, "path": [ { - "description": "The unique identifier of the query ruleset to be created or updated.", - "name": "ruleset_id", + "description": "Identifier for the job.", + "name": "job_id", "required": true, "type": { "kind": "instance_of", @@ -38296,356 +37817,244 @@ } ], "query": [], - "specLocation": "query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L59" + "specLocation": "ml/update_job/MlUpdateJobRequest.ts#L33-L147" }, { "body": { "kind": "properties", "properties": [ { - "name": "result", + "name": "allow_lazy_open", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Result", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "query_rules.put_ruleset" - }, - "specLocation": "query_rules/put_ruleset/QueryRulesetPutResponse.ts#L22-L26" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "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.", - "name": "match_criteria", + "name": "analysis_config", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "AnalysisConfigRead", + "namespace": "ml._types" } } - } - ] - }, - "description": "Test a query ruleset.\nEvaluate match criteria against a query ruleset to identify the rules that would match that 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}" - } - }, - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "query_rules.test" - }, - "path": [ - { - "description": "The unique identifier of the query ruleset to be created or updated", - "name": "ruleset_id", - "required": true, - "type": { - "kind": "instance_of", + }, + { + "name": "analysis_limits", + "required": true, "type": { - "name": "Id", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "AnalysisLimits", + "namespace": "ml._types" + } } - } - } - ], - "query": [], - "specLocation": "query_rules/test/QueryRulesetTestRequest.ts#L24-L57" - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "name": "total_matched_rules", - "required": true, + "name": "background_persist_interval", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Duration", "namespace": "_types" } } }, { - "name": "matched_rules", + "name": "create_time", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryRulesetMatchedRule", - "namespace": "query_rules.test" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" } } - } - ] - }, - "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}" - } - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "query_rules.test" - }, - "specLocation": "query_rules/test/QueryRulesetTestResponse.ts#L23-L28" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "description": "A set of typical search requests, together with their provided ratings.", - "name": "requests", - "required": true, + "name": "finished_time", + "required": false, "type": { - "kind": "array_of", + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } + }, + { + "name": "custom_settings", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "RankEvalRequestItem", - "namespace": "_global.rank_eval" + "name": "string", + "namespace": "_builtins" } } } }, { - "description": "Definition of the evaluation metric to calculate.", - "name": "metric", - "required": false, + "name": "daily_model_snapshot_retention_after_days", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "RankEvalMetric", - "namespace": "_global.rank_eval" + "name": "long", + "namespace": "_types" } } - } - ] - }, - "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "request", - "name": { - "name": "Request", - "namespace": "_global.rank_eval" - }, - "path": [ - { - "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 `*`.", - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "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`.", - "name": "allow_no_indices", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", + }, + { + "name": "data_description", + "required": true, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "DataDescription", + "namespace": "ml._types" + } } - } - }, - { - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "name": "expand_wildcards", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "datafeed_config", + "required": false, "type": { - "name": "ExpandWildcards", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "Datafeed", + "namespace": "ml._types" + } } - } - }, - { - "description": "If `true`, missing or closed indices are not included in the response.", - "name": "ignore_unavailable", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", + }, + { + "name": "description", + "required": false, "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - }, - { - "description": "Search operation type", - "name": "search_type", - "required": false, - "type": { - "kind": "instance_of", + }, + { + "name": "groups", + "required": false, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - } - } - ], - "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L76" - }, - { - "body": { - "kind": "properties", - "properties": [ + }, { - "description": "The overall evaluation quality calculated by the defined metric", - "name": "metric_score", + "name": "job_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Id", "namespace": "_types" } } }, { - "description": "The details section contains one entry for every query in the original requests section, keyed by the search request id", - "name": "details", + "name": "job_type", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "RankEvalMetricDetail", - "namespace": "_global.rank_eval" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "failures", + "name": "job_version", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" } } - } - ] - }, - "kind": "response", - "name": { - "name": "Response", - "namespace": "_global.rank_eval" - }, - "specLocation": "_global/rank_eval/RankEvalResponse.ts#L26-L34" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ + }, { - "description": "Indicates whether to continue reindexing even when there are conflicts.", - "name": "conflicts", + "name": "model_plot_config", "required": false, - "serverDefault": "abort", "type": { "kind": "instance_of", "type": { - "name": "Conflicts", + "name": "ModelPlotConfig", + "namespace": "ml._types" + } + } + }, + { + "name": "model_snapshot_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", "namespace": "_types" } } }, { - "description": "The destination you are copying to.", - "name": "dest", + "name": "model_snapshot_retention_days", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Destination", - "namespace": "_global.reindex" + "name": "long", + "namespace": "_types" } } }, { - "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.", - "name": "max_docs", + "name": "renormalization_window_days", "required": false, "type": { "kind": "instance_of", @@ -38656,19 +38065,18 @@ } }, { - "description": "The script to run to update the document source or metadata when reindexing.", - "name": "script", - "required": false, + "name": "results_index_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "size", + "name": "results_retention_days", "required": false, "type": { "kind": "instance_of", @@ -38677,89 +38085,51 @@ "namespace": "_types" } } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.update_job" + }, + "specLocation": "ml/update_job/MlUpdateJobResponse.ts#L29-L53" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "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.", + "name": "number_of_allocations", + "required": false, + "serverDefault": 1, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "description": "The source you are copying from.", - "name": "source", - "required": true, + "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.", + "name": "adaptive_allocations", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Source", - "namespace": "_global.reindex" + "name": "AdaptiveAllocationsSettings", + "namespace": "ml._types" } } } ] }, - "description": "Reindex documents.\n\nCopy 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\nNOTE: The reindex API makes no effort to handle ID collisions.\nThe last document written will \"win\" but the order isn't usually predictable so it is not a good idea to rely on this behavior.\nInstead, make sure that IDs are unique by using a script.\n\n**Running reindex asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `_tasks/`.\n\n**Reindex from multiple sources**\n\nIf you have many sources to reindex it is generally better to reindex them one at a time rather than using a glob pattern to pick up multiple sources.\nThat way you can resume the process if there are any errors by removing the partially completed source and starting over.\nIt also makes parallelizing the process fairly simple: split the list of sources to reindex and run each list in parallel.\n\nFor example, you can use a bash script like this:\n\n```\nfor index in i1 i2 i3 i4 i5; do\n curl -HContent-Type:application/json -XPOST localhost:9200/_reindex?pretty -d'{\n \"source\": {\n \"index\": \"'$index'\"\n },\n \"dest\": {\n \"index\": \"'$index'-reindexed\"\n }\n }'\ndone\n```\n\n**Throttling**\n\nSet `requests_per_second` to any positive decimal number (`1.4`, `6`, `1000`, for example) to throttle the rate at which reindex issues batches of index operations.\nRequests are throttled by padding each batch with a wait time.\nTo turn off throttling, set `requests_per_second` to `-1`.\n\nThe throttling is done by waiting between batches so that the scroll that reindex uses internally can be given a timeout that takes into account the padding.\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 then wait for a while before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\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\nYou can slice a reindex request manually by providing a slice ID and total number of slices to each request.\nYou can also let reindex automatically parallelize by using sliced scroll to slice on `_id`.\nThe `slices` parameter specifies the number of slices to use.\n\nAdding `slices` to the reindex request just automates the manual process, creating sub-requests which means it has some quirks:\n\n* You can see these requests in the tasks API. 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 previous point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being reindexed.\n* Each sub-request gets a slightly different snapshot of the source, though these are all taken at approximately the same time.\n\nIf slicing automatically, setting `slices` to `auto` will choose a reasonable number for most indices.\nIf slicing manually or otherwise tuning automatic slicing, use the following guidelines.\n\nQuery performance is most efficient when the number of slices is equal to the number of shards in the index.\nIf that number is large (for example, `500`), choose a lower number as too many slices will hurt performance.\nSetting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n\nIndexing performance scales linearly across available resources with the number of slices.\n\nWhether query or indexing performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Modify documents during reindexing**\n\nLike `_update_by_query`, reindex operations support a script that modifies the document.\nUnlike `_update_by_query`, the script is allowed to modify the document's metadata.\n\nJust as in `_update_by_query`, you can set `ctx.op` to change the operation that is run on the destination.\nFor example, set `ctx.op` to `noop` if your script decides that the document doesn’t have to be indexed in the destination. This \"no operation\" will be reported in the `noop` counter in the response body.\nSet `ctx.op` to `delete` if your script decides that the document must be deleted from the destination.\nThe deletion will be reported in the `deleted` counter in the response body.\nSetting `ctx.op` to anything else will return an error, as will setting any other field in `ctx`.\n\nThink of the possibilities! Just be careful; you are able to change:\n\n* `_id`\n* `_index`\n* `_version`\n* `_routing`\n\nSetting `_version` to `null` or clearing it from the `ctx` map is just like not sending the version in an indexing request.\nIt will cause the document to be overwritten in the destination regardless of the version on the target or the version type you use in the reindex API.\n\n**Reindex from remote**\n\nReindex supports reindexing from a remote Elasticsearch cluster.\nThe `host` parameter must contain a scheme, host, port, and optional path.\nThe `username` and `password` parameters are optional and when they are present the reindex operation will connect to the remote Elasticsearch node using basic authentication.\nBe sure to use HTTPS when using basic authentication or the password will be sent in plain text.\nThere are a range of settings available to configure the behavior of the HTTPS connection.\n\nWhen using Elastic Cloud, it is also possible to authenticate against the remote cluster through the use of a valid API key.\nRemote hosts must be explicitly allowed with the `reindex.remote.whitelist` setting.\nIt can be set to a comma delimited list of allowed remote host and port combinations.\nScheme is ignored; only the host and port are used.\nFor example:\n\n```\nreindex.remote.whitelist: [otherhost:9200, another:9200, 127.0.10.*:9200, localhost:*\"]\n```\n\nThe list of allowed hosts must be configured on any nodes that will coordinate the reindex.\nThis feature should work with remote clusters of any version of Elasticsearch.\nThis should enable you to upgrade from any version of Elasticsearch to the current version by reindexing from a cluster of the old version.\n\nWARNING: Elasticsearch does not support forward compatibility across major versions.\nFor example, you cannot reindex from a 7.x cluster into a 6.x cluster.\n\nTo enable queries sent to older versions of Elasticsearch, the `query` parameter is sent directly to the remote host without validation or modification.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nReindexing from a remote server uses an on-heap buffer that defaults to a maximum size of 100mb.\nIf the remote index includes very large documents you'll need to use a smaller batch size.\nIt is also possible to set the socket read timeout on the remote connection with the `socket_timeout` field and the connection timeout with the `connect_timeout` field.\nBoth default to 30 seconds.\n\n**Configuring SSL parameters**\n\nReindex from remote supports configurable SSL settings.\nThese must be specified in the `elasticsearch.yml` file, with the exception of the secure settings, which you add in the Elasticsearch keystore.\nIt is not possible to configure SSL in the body of the reindex request.", - "examples": { - "ReindexRequestExample1": { - "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", - "summary": "Reindex multiple sources", - "value": "{\n \"source\": {\n \"index\": [\"my-index-000001\", \"my-index-000002\"]\n },\n \"dest\": {\n \"index\": \"my-new-index-000002\"\n }\n}" - }, - "ReindexRequestExample10": { - "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", - "summary": "Reindex with Painless", - "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": { - "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", - "summary": "Reindex a random subset", - "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": { - "description": "Run `POST _reindex` to modify documents during reindexing. This example bumps the version of the source document.\n", - "summary": "Reindex modified documents", - "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": { - "description": "When using Elastic Cloud, you can run `POST _reindex` and authenticate against a remote cluster with an API key.\n", - "summary": "Reindex from remote on Elastic Cloud", - "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": { - "description": "Run `POST _reindex` to slice a reindex request manually. Provide a slice ID and total number of slices to each request.\n", - "summary": "Manual slicing", - "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": { - "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", - "summary": "Automatic slicing", - "value": "{\n \"source\": {\n \"index\": \"my-index-000001\"\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\"\n }\n}" - }, - "ReindexRequestExample4": { - "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", - "summary": "Routing", - "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": { - "description": "Run `POST _reindex` and use the ingest pipelines feature.", - "summary": "Ingest pipelines", - "value": "{\n \"source\": {\n \"index\": \"source\"\n },\n \"dest\": {\n \"index\": \"dest\",\n \"pipeline\": \"some_ingest_pipeline\"\n }\n}" - }, - "ReindexRequestExample6": { - "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", - "summary": "Reindex with a query", - "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": { - "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", - "summary": "Reindex with max_docs", - "value": "{\n \"max_docs\": 1,\n \"source\": {\n \"index\": \"my-index-000001\"\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\"\n }\n}" - }, - "ReindexRequestExample8": { - "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", - "summary": "Reindex selected fields", - "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": { - "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", - "summary": "Reindex new field names", - "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}" - } - }, + "description": "Update a trained model deployment.", "inherits": { "type": { "name": "RequestBase", @@ -38769,94 +38139,152 @@ "kind": "request", "name": { "name": "Request", - "namespace": "_global.reindex" + "namespace": "ml.update_trained_model_deployment" }, - "path": [], - "query": [ - { - "description": "If `true`, the request refreshes affected shards to make this operation visible to search.", - "name": "refresh", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, + "path": [ { - "description": "The throttle for this request in sub-requests per second.\nBy default, there is no throttle.", - "name": "requests_per_second", - "required": false, - "serverDefault": -1, + "description": "The unique identifier of the trained model. Currently, only PyTorch models are supported.", + "name": "model_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "Id", "namespace": "_types" } } - }, + } + ], + "query": [ { - "description": "The period of time that a consistent view of the index should be maintained for scrolled search.", - "name": "scroll", + "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.", + "name": "number_of_allocations", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } - }, - { - "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.", - "extDocId": "slice-scroll", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#slice-scroll", - "name": "slices", + } + ], + "specLocation": "ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts#L25-L78" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "assignment", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "TrainedModelAssignment", + "namespace": "ml._types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "ml.update_trained_model_deployment" + }, + "specLocation": "ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "codegenName": "searches", + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RequestItem", + "namespace": "_global.msearch" + } + } + } + }, + "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "_global.msearch" + }, + "path": [ + { + "description": "Comma-separated list of data streams, indices, and index aliases to search.", + "name": "index", "required": false, - "serverDefault": "1", "type": { "kind": "instance_of", "type": { - "name": "Slices", + "name": "Indices", "namespace": "_types" } } + } + ], + "query": [ + { + "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.", + "name": "allow_no_indices", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "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.", - "name": "timeout", + "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", + "docId": "ccs-network-delays", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html#ccs-network-delays", + "name": "ccs_minimize_roundtrips", "required": false, - "serverDefault": "1m", + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "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.", - "name": "wait_for_active_shards", + "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.", + "name": "expand_wildcards", "required": false, - "serverDefault": "1", "type": { "kind": "instance_of", "type": { - "name": "WaitForActiveShards", + "name": "ExpandWildcards", "namespace": "_types" } } }, { - "description": "If `true`, the request blocks until the operation is complete.", - "name": "wait_for_completion", + "description": "If true, concrete, expanded or aliased indices are ignored when frozen.", + "name": "ignore_throttled", "required": false, - "serverDefault": true, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -38866,8 +38294,8 @@ } }, { - "description": "If `true`, the destination must be an index alias.", - "name": "require_alias", + "description": "If true, missing or closed indices are not included in the response.", + "name": "ignore_unavailable", "required": false, "serverDefault": false, "type": { @@ -38877,311 +38305,165 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "_global/reindex/ReindexRequest.ts#L27-L309" - }, - { - "body": { - "kind": "properties", - "properties": [ - { - "description": "The number of scroll responses that were pulled back by the reindex.", - "name": "batches", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The number of documents that were successfully created.", - "name": "created", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The number of documents that were successfully deleted.", - "name": "deleted", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "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.", - "name": "failures", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "BulkIndexByScrollFailure", - "namespace": "_types" - } - } - } - }, - { - "description": "The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`.", - "name": "noops", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The number of retries attempted by reindex.", - "name": "retries", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Retries", - "namespace": "_types" - } - } - }, - { - "description": "The number of requests per second effectively run during the reindex.", - "name": "requests_per_second", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } - }, - { - "name": "slice_id", - "required": false, + }, + { + "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.", + "name": "include_named_queries_score", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "name": "task", - "required": false, + } + }, + { + "description": "Maximum number of concurrent searches the multi search API can execute.", + "name": "max_concurrent_searches", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "TaskId", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "description": "The number of milliseconds the request slept to conform to `requests_per_second`.", - "name": "throttled_millis", - "required": false, + } + }, + { + "description": "Maximum number of concurrent shard requests that each sub-search request executes per node.", + "name": "max_concurrent_shard_requests", + "required": false, + "serverDefault": 5, + "type": { + "kind": "instance_of", "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "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`.", - "name": "throttled_until_millis", - "required": false, + } + }, + { + "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.", + "name": "pre_filter_shard_size", + "required": false, + "type": { + "kind": "instance_of", "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } + "name": "long", + "namespace": "_types" } - }, - { - "description": "If any of the requests that ran during the reindex timed out, it is `true`.", - "name": "timed_out", - "required": false, + } + }, + { + "description": "If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.", + "name": "rest_total_hits_as_int", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "description": "The total milliseconds the entire operation took.", - "name": "took", - "required": false, + } + }, + { + "description": "Custom routing value used to route search operations to a specific shard.", + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } + "name": "Routing", + "namespace": "_types" } - }, - { - "description": "The number of documents that were successfully processed.", - "name": "total", - "required": false, + } + }, + { + "description": "Indicates whether global term and document frequencies should be used when scoring returned documents.", + "name": "search_type", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "SearchType", + "namespace": "_types" } - }, - { - "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.", - "name": "updated", - "required": false, + } + }, + { + "description": "Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.", + "name": "typed_keys", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "boolean", + "namespace": "_builtins" } - }, - { - "description": "The number of version conflicts that occurred.", - "name": "version_conflicts", - "required": false, - "type": { + } + } + ], + "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L135" + }, + { + "body": { + "kind": "value", + "value": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "TDocument", + "namespace": "_global.msearch.Response" } } + ], + "kind": "instance_of", + "type": { + "name": "MultiSearchResult", + "namespace": "_global.msearch" } - ] + } }, + "generics": [ + { + "name": "TDocument", + "namespace": "_global.msearch.Response" + } + ], "kind": "response", "name": { "name": "Response", - "namespace": "_global.reindex" + "namespace": "_global.msearch" }, - "specLocation": "_global/reindex/ReindexResponse.ts#L26-L92" + "specLocation": "_global/msearch/MultiSearchResponse.ts#L25-L27" }, { "attachedBehaviors": [ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "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 ``.", - "name": "id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "file", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", - "name": "params", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "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.", - "name": "source", - "required": false, + "codegenName": "search_templates", + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "RequestItem", + "namespace": "_global.msearch_template" } } - ] + } }, - "description": "Render a search template.\n\nRender a search template as a search request body.", + "description": "Run multiple templated searches.\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```", "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}" + "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\" }}" } }, "inherits": { @@ -39193,55 +38475,121 @@ "kind": "request", "name": { "name": "Request", - "namespace": "_global.render_search_template" + "namespace": "_global.msearch_template" }, "path": [ { - "description": "The ID of the search template to render.\nIf no `source` is specified, this or the `id` request body parameter is required.", - "name": "id", + "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 `*`.", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Indices", "namespace": "_types" } } } ], - "query": [], - "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L76" + "query": [ + { + "description": "If `true`, network round-trips are minimized for cross-cluster search requests.", + "name": "ccs_minimize_roundtrips", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The maximum number of concurrent searches the API can run.", + "name": "max_concurrent_searches", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "The type of the search operation.", + "name": "search_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SearchType", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, the response returns `hits.total` as an integer.\nIf `false`, it returns `hits.total` as an object.", + "name": "rest_total_hits_as_int", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, the response prefixes aggregation and suggester names with their respective types.", + "name": "typed_keys", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L116" }, { "body": { - "kind": "properties", - "properties": [ - { - "name": "template_output", - "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "value", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.msearch_template.Response" } } + ], + "kind": "instance_of", + "type": { + "name": "MultiSearchResult", + "namespace": "_global.msearch" } - ] + } }, + "generics": [ + { + "name": "TDocument", + "namespace": "_global.msearch_template.Response" + } + ], "kind": "response", "name": { "name": "Response", - "namespace": "_global.render_search_template" + "namespace": "_global.msearch_template" }, - "specLocation": "_global/render_search_template/RenderSearchTemplateResponse.ts#L23-L25" + "specLocation": "_global/msearch_template/MultiSearchTemplateResponse.ts#L22-L31" }, { "attachedBehaviors": [ @@ -39251,60 +38599,53 @@ "kind": "properties", "properties": [ { - "description": "The context that the script should run in.\nNOTE: Result ordering in the field contexts is not guaranteed.", - "name": "context", - "required": false, - "serverDefault": "painless_test", - "type": { - "kind": "instance_of", - "type": { - "name": "PainlessContext", - "namespace": "_global.scripts_painless_execute" - } - } - }, - { - "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`.", - "name": "context_setup", + "description": "An array of existing or artificial documents.", + "name": "docs", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "PainlessContextSetup", - "namespace": "_global.scripts_painless_execute" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Operation", + "namespace": "_global.mtermvectors" + } } } }, { - "description": "The Painless script to run.", - "name": "script", + "description": "A simplified syntax to specify documents by their ID if they're in the same index.", + "name": "ids", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } } } ] }, - "description": "Run a script.\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.", + "description": "Get multiple term vectors.\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`.", "examples": { - "ExecutePainlessScriptRequestExample1": { - "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", - "summary": "Test context", - "value": "{\n \"script\": {\n \"source\": \"params.count / params.total\",\n \"params\": {\n \"count\": 100.0,\n \"total\": 1000.0\n }\n }\n}" + "MultiTermVectorsRequestExample1": { + "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", + "summary": "Get multiple term vectors", + "value": "{\n \"docs\": [\n {\n \"_id\": \"2\",\n \"fields\": [\n \"message\"\n ],\n \"term_statistics\": true\n },\n {\n \"_id\": \"1\"\n }\n ]\n}" }, - "ExecutePainlessScriptRequestExample2": { - "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", - "summary": "Filter context", - "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}" + "MultiTermVectorsRequestExample2": { + "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", + "summary": "Simplified syntax", + "value": "{\n \"ids\": [ \"1\", \"2\" ],\n \"fields\": [\n \"message\"\n ],\n \"term_statistics\": true\n}" }, - "ExecutePainlessScriptRequestExample3": { - "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", - "summary": "Score context", - "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}" + "MultiTermVectorsRequestExample3": { + "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", + "summary": "Artificial documents", + "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}" } }, "inherits": { @@ -39316,58 +38657,207 @@ "kind": "request", "name": { "name": "Request", - "namespace": "_global.scripts_painless_execute" + "namespace": "_global.mtermvectors" }, - "path": [], - "query": [], - "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts#L24-L64" + "path": [ + { + "description": "The name of the index that contains the documents.", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body", + "name": "ids", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + }, + { + "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.", + "name": "fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", + "name": "field_statistics", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, the response includes term offsets.", + "name": "offsets", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, the response includes term payloads.", + "name": "payloads", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, the response includes term positions.", + "name": "positions", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The node or shard the operation should be performed on.\nIt is random by default.", + "name": "preference", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "If true, the request is real-time as opposed to near-real-time.", + "docId": "realtime", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "name": "realtime", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "A custom value used to route operations to a specific shard.", + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" + } + } + }, + { + "description": "If true, the response includes term frequency and document frequency.", + "name": "term_statistics", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, returns the document version as part of a hit.", + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "description": "The version type.", + "name": "version_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionType", + "namespace": "_types" + } + } + } + ], + "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L134" }, { "body": { "kind": "properties", "properties": [ { - "name": "result", + "name": "docs", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "TResult", - "namespace": "_global.scripts_painless_execute.Response" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TermVectorsResult", + "namespace": "_global.mtermvectors" + } } } } ] }, - "examples": { - "ExecutePainlessScriptResponseExample1": { - "description": "A successful response from `POST /_scripts/painless/_execute` with a `painless_test` context.", - "summary": "Test context", - "value": "{\n \"result\": \"0.1\"\n}" - }, - "ExecutePainlessScriptResponseExample2": { - "description": "A successful response from `POST /_scripts/painless/_execute` with a `filter` context.", - "summary": "Filter context", - "value": "{\n \"result\": true\n}" - }, - "ExecutePainlessScriptResponseExample3": { - "description": "A successful response from `POST /_scripts/painless/_execute` with a `score` context.", - "summary": "Score context", - "value": "{\n \"result\": 0.8\n}" - } - }, - "generics": [ - { - "name": "TResult", - "namespace": "_global.scripts_painless_execute.Response" - } - ], "kind": "response", "name": { "name": "Response", - "namespace": "_global.scripts_painless_execute" + "namespace": "_global.mtermvectors" }, - "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptResponse.ts#L20-L24" + "specLocation": "_global/mtermvectors/MultiTermVectorsResponse.ts#L22-L24" }, { "attachedBehaviors": [ @@ -39377,41 +38867,20 @@ "kind": "properties", "properties": [ { - "description": "The period to retain the search context for scrolling.", - "docId": "scroll-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", - "name": "scroll", + "description": "Filter indices if the provided query rewrites to `match_none` on every shard.", + "name": "index_filter", "required": false, - "serverDefault": "1d", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The scroll ID of the search.", - "name": "scroll_id", - "required": true, "type": { "kind": "instance_of", "type": { - "name": "ScrollId", - "namespace": "_types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } } ] }, - "description": "Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", - "examples": { - "ScrollRequestExample1": { - "description": "Run `GET /_search/scroll` to get the next batch of results for a scrolling search.", - "value": "{\n \"scroll_id\" : \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}" - } - }, + "description": "Open a point in time.\n\nA 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.", "inherits": { "type": { "name": "RequestBase", @@ -39421,21 +38890,17 @@ "kind": "request", "name": { "name": "Request", - "namespace": "_global.scroll" + "namespace": "_global.open_point_in_time" }, "path": [ { - "deprecation": { - "description": "", - "version": "7.0.0" - }, - "description": "The scroll ID", - "name": "scroll_id", - "required": false, + "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", + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ScrollId", + "name": "Indices", "namespace": "_types" } } @@ -39443,12 +38908,9 @@ ], "query": [ { - "description": "The period to retain the search context for scrolling.", - "docId": "scroll-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", - "name": "scroll", - "required": false, - "serverDefault": "1d", + "description": "Extend the length of time that the point in time persists.", + "name": "keep_alive", + "required": true, "type": { "kind": "instance_of", "type": { @@ -39458,24 +38920,58 @@ } }, { - "deprecation": { - "description": "", - "version": "7.0.0" - }, - "description": "The scroll ID for scrolled search", - "name": "scroll_id", + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "ScrollId", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The node or shard the operation should be performed on.\nBy default, it is random.", + "name": "preference", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "A custom value that is used to route operations to a specific shard.", + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", "namespace": "_types" } } }, { - "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.", - "name": "rest_total_hits_as_int", + "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`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "name": "expand_wildcards", + "required": false, + "serverDefault": "open", + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "allow_partial_search_results", "required": false, "serverDefault": false, "type": { @@ -39487,20 +38983,1975 @@ } } ], - "specLocation": "_global/scroll/ScrollRequest.ts#L24-L88" + "specLocation": "_global/open_point_in_time/OpenPointInTimeRequest.ts#L25-L121" }, { "body": { - "kind": "value", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.scroll.Response" - } - } + "kind": "properties", + "properties": [ + { + "description": "Shards used to create the PIT", + "name": "_shards", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ShardStatistics", + "namespace": "_types" + } + } + }, + { + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ] + }, + "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}" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "_global.open_point_in_time" + }, + "specLocation": "_global/open_point_in_time/OpenPointInTimeResponse.ts#L23-L29" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Ping the cluster.\nGet information about whether the cluster is running.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "_global.ping" + }, + "path": [], + "query": [], + "specLocation": "_global/ping/PingRequest.ts#L22-L38" + }, + { + "body": { + "kind": "no_body" + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "_global.ping" + }, + "specLocation": "_global/ping/PingResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "The script or search template, its parameters, and its language.", + "name": "script", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "StoredScript", + "namespace": "_types" + } + } + } + ] + }, + "description": "Create or update a script or search template.\nCreates or updates a stored script or search template.", + "examples": { + "PutScriptRequestExample1": { + "description": "Run `PUT _scripts/my-search-template` to create a search template.\n", + "summary": "Create a search template", + "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": { + "description": "Run `PUT _scripts/my-stored-script` to create a stored script.\n", + "summary": "Create a stored script", + "value": "{\n \"script\": {\n \"lang\": \"painless\",\n \"source\": \"Math.log(_score * 2) + params['my_modifier']\"\n }\n}" + } + }, + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "_global.put_script" + }, + "path": [ + { + "description": "The identifier for the stored script or search template.\nIt must be unique within the cluster.", + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "context", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "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.", + "name": "context", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "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.", + "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.\nIt can also be set to `-1` to indicate that the request should never timeout.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "_global/put_script/PutScriptRequest.ts#L25-L87" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "_global.put_script" + }, + "specLocation": "_global/put_script/PutScriptResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Delete a query rule.\nDelete 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.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "query_rules.delete_rule" + }, + "path": [ + { + "description": "The unique identifier of the query ruleset containing the rule to delete", + "name": "ruleset_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "The unique identifier of the query rule within the specified ruleset to delete", + "name": "rule_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "query_rules/delete_rule/QueryRuleDeleteRequest.ts#L22-L50" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "query_rules.delete_rule" + }, + "specLocation": "query_rules/delete_rule/QueryRuleDeleteResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Delete a query ruleset.\nRemove a query ruleset and its associated data.\nThis is a destructive action that is not recoverable.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "query_rules.delete_ruleset" + }, + "path": [ + { + "description": "The unique identifier of the query ruleset to delete", + "name": "ruleset_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts#L22-L45" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "query_rules.delete_ruleset" + }, + "specLocation": "query_rules/delete_ruleset/QueryRulesetDeleteResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Get a query rule.\nGet details about a query rule within a query ruleset.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "query_rules.get_rule" + }, + "path": [ + { + "description": "The unique identifier of the query ruleset containing the rule to retrieve", + "name": "ruleset_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "The unique identifier of the query rule within the specified ruleset to retrieve", + "name": "rule_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "query_rules/get_rule/QueryRuleGetRequest.ts#L22-L50" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryRule", + "namespace": "query_rules._types" + } + } + }, + "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}" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "query_rules.get_rule" + }, + "specLocation": "query_rules/get_rule/QueryRuleGetResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Get a query ruleset.\nGet details about a query ruleset.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "query_rules.get_ruleset" + }, + "path": [ + { + "description": "The unique identifier of the query ruleset", + "name": "ruleset_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "query_rules/get_ruleset/QueryRulesetGetRequest.ts#L22-L44" + }, + { + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryRuleset", + "namespace": "query_rules._types" + } + } + }, + "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}" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "query_rules.get_ruleset" + }, + "specLocation": "query_rules/get_ruleset/QueryRulesetGetResponse.ts#L22-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Get all query rulesets.\nGet summarized information about the query rulesets.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "query_rules.list_rulesets" + }, + "path": [], + "query": [ + { + "description": "The offset from the first result to fetch.", + "name": "from", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The maximum number of results to retrieve.", + "name": "size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "query_rules/list_rulesets/QueryRulesetListRequest.ts#L22-L49" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "results", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryRulesetListItem", + "namespace": "query_rules.list_rulesets" + } + } + } + } + ] + }, + "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}" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "query_rules.list_rulesets" + }, + "specLocation": "query_rules/list_rulesets/QueryRulesetListResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "The type of rule.", + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryRuleType", + "namespace": "query_rules._types" + } + } + }, + { + "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.", + "name": "criteria", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "QueryRuleCriteria", + "namespace": "query_rules._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryRuleCriteria", + "namespace": "query_rules._types" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.", + "name": "actions", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryRuleActions", + "namespace": "query_rules._types" + } + } + }, + { + "name": "priority", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ] + }, + "description": "Create or update a query rule.\nCreate 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.", + "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}" + } + }, + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "query_rules.put_rule" + }, + "path": [ + { + "description": "The unique identifier of the query ruleset containing the rule to be created or updated.", + "name": "ruleset_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "The unique identifier of the query rule within the specified ruleset to be created or updated.", + "name": "rule_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "query_rules/put_rule/QueryRulePutRequest.ts#L28-L79" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "query_rules.put_rule" + }, + "specLocation": "query_rules/put_rule/QueryRulePutResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "rules", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "QueryRule", + "namespace": "query_rules._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryRule", + "namespace": "query_rules._types" + } + } + } + ], + "kind": "union_of" + } + } + ] + }, + "description": "Create or update a query ruleset.\nThere 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.", + "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}" + } + }, + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "query_rules.put_ruleset" + }, + "path": [ + { + "description": "The unique identifier of the query ruleset to be created or updated.", + "name": "ruleset_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L59" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "query_rules.put_ruleset" + }, + "specLocation": "query_rules/put_ruleset/QueryRulesetPutResponse.ts#L22-L26" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "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.", + "name": "match_criteria", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ] + }, + "description": "Test a query ruleset.\nEvaluate match criteria against a query ruleset to identify the rules that would match that 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}" + } + }, + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "query_rules.test" + }, + "path": [ + { + "description": "The unique identifier of the query ruleset to be created or updated", + "name": "ruleset_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "query_rules/test/QueryRulesetTestRequest.ts#L24-L57" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "total_matched_rules", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "matched_rules", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryRulesetMatchedRule", + "namespace": "query_rules.test" + } + } + } + } + ] + }, + "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}" + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "query_rules.test" + }, + "specLocation": "query_rules/test/QueryRulesetTestResponse.ts#L23-L28" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "A set of typical search requests, together with their provided ratings.", + "name": "requests", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RankEvalRequestItem", + "namespace": "_global.rank_eval" + } + } + } + }, + { + "description": "Definition of the evaluation metric to calculate.", + "name": "metric", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RankEvalMetric", + "namespace": "_global.rank_eval" + } + } + } + ] + }, + "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "_global.rank_eval" + }, + "path": [ + { + "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 `*`.", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "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`.", + "name": "allow_no_indices", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "expand_wildcards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, missing or closed indices are not included in the response.", + "name": "ignore_unavailable", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Search operation type", + "name": "search_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L76" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "description": "The overall evaluation quality calculated by the defined metric", + "name": "metric_score", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "description": "The details section contains one entry for every query in the original requests section, keyed by the search request id", + "name": "details", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "RankEvalMetricDetail", + "namespace": "_global.rank_eval" + } + } + } + }, + { + "name": "failures", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "_global.rank_eval" + }, + "specLocation": "_global/rank_eval/RankEvalResponse.ts#L26-L34" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "Indicates whether to continue reindexing even when there are conflicts.", + "name": "conflicts", + "required": false, + "serverDefault": "abort", + "type": { + "kind": "instance_of", + "type": { + "name": "Conflicts", + "namespace": "_types" + } + } + }, + { + "description": "The destination you are copying to.", + "name": "dest", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Destination", + "namespace": "_global.reindex" + } + } + }, + { + "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.", + "name": "max_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "The script to run to update the document source or metadata when reindexing.", + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } + }, + { + "name": "size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "The source you are copying from.", + "name": "source", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Source", + "namespace": "_global.reindex" + } + } + } + ] + }, + "description": "Reindex documents.\n\nCopy 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\nNOTE: The reindex API makes no effort to handle ID collisions.\nThe last document written will \"win\" but the order isn't usually predictable so it is not a good idea to rely on this behavior.\nInstead, make sure that IDs are unique by using a script.\n\n**Running reindex asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `_tasks/`.\n\n**Reindex from multiple sources**\n\nIf you have many sources to reindex it is generally better to reindex them one at a time rather than using a glob pattern to pick up multiple sources.\nThat way you can resume the process if there are any errors by removing the partially completed source and starting over.\nIt also makes parallelizing the process fairly simple: split the list of sources to reindex and run each list in parallel.\n\nFor example, you can use a bash script like this:\n\n```\nfor index in i1 i2 i3 i4 i5; do\n curl -HContent-Type:application/json -XPOST localhost:9200/_reindex?pretty -d'{\n \"source\": {\n \"index\": \"'$index'\"\n },\n \"dest\": {\n \"index\": \"'$index'-reindexed\"\n }\n }'\ndone\n```\n\n**Throttling**\n\nSet `requests_per_second` to any positive decimal number (`1.4`, `6`, `1000`, for example) to throttle the rate at which reindex issues batches of index operations.\nRequests are throttled by padding each batch with a wait time.\nTo turn off throttling, set `requests_per_second` to `-1`.\n\nThe throttling is done by waiting between batches so that the scroll that reindex uses internally can be given a timeout that takes into account the padding.\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 then wait for a while before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\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\nYou can slice a reindex request manually by providing a slice ID and total number of slices to each request.\nYou can also let reindex automatically parallelize by using sliced scroll to slice on `_id`.\nThe `slices` parameter specifies the number of slices to use.\n\nAdding `slices` to the reindex request just automates the manual process, creating sub-requests which means it has some quirks:\n\n* You can see these requests in the tasks API. 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 previous point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being reindexed.\n* Each sub-request gets a slightly different snapshot of the source, though these are all taken at approximately the same time.\n\nIf slicing automatically, setting `slices` to `auto` will choose a reasonable number for most indices.\nIf slicing manually or otherwise tuning automatic slicing, use the following guidelines.\n\nQuery performance is most efficient when the number of slices is equal to the number of shards in the index.\nIf that number is large (for example, `500`), choose a lower number as too many slices will hurt performance.\nSetting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n\nIndexing performance scales linearly across available resources with the number of slices.\n\nWhether query or indexing performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Modify documents during reindexing**\n\nLike `_update_by_query`, reindex operations support a script that modifies the document.\nUnlike `_update_by_query`, the script is allowed to modify the document's metadata.\n\nJust as in `_update_by_query`, you can set `ctx.op` to change the operation that is run on the destination.\nFor example, set `ctx.op` to `noop` if your script decides that the document doesn’t have to be indexed in the destination. This \"no operation\" will be reported in the `noop` counter in the response body.\nSet `ctx.op` to `delete` if your script decides that the document must be deleted from the destination.\nThe deletion will be reported in the `deleted` counter in the response body.\nSetting `ctx.op` to anything else will return an error, as will setting any other field in `ctx`.\n\nThink of the possibilities! Just be careful; you are able to change:\n\n* `_id`\n* `_index`\n* `_version`\n* `_routing`\n\nSetting `_version` to `null` or clearing it from the `ctx` map is just like not sending the version in an indexing request.\nIt will cause the document to be overwritten in the destination regardless of the version on the target or the version type you use in the reindex API.\n\n**Reindex from remote**\n\nReindex supports reindexing from a remote Elasticsearch cluster.\nThe `host` parameter must contain a scheme, host, port, and optional path.\nThe `username` and `password` parameters are optional and when they are present the reindex operation will connect to the remote Elasticsearch node using basic authentication.\nBe sure to use HTTPS when using basic authentication or the password will be sent in plain text.\nThere are a range of settings available to configure the behavior of the HTTPS connection.\n\nWhen using Elastic Cloud, it is also possible to authenticate against the remote cluster through the use of a valid API key.\nRemote hosts must be explicitly allowed with the `reindex.remote.whitelist` setting.\nIt can be set to a comma delimited list of allowed remote host and port combinations.\nScheme is ignored; only the host and port are used.\nFor example:\n\n```\nreindex.remote.whitelist: [otherhost:9200, another:9200, 127.0.10.*:9200, localhost:*\"]\n```\n\nThe list of allowed hosts must be configured on any nodes that will coordinate the reindex.\nThis feature should work with remote clusters of any version of Elasticsearch.\nThis should enable you to upgrade from any version of Elasticsearch to the current version by reindexing from a cluster of the old version.\n\nWARNING: Elasticsearch does not support forward compatibility across major versions.\nFor example, you cannot reindex from a 7.x cluster into a 6.x cluster.\n\nTo enable queries sent to older versions of Elasticsearch, the `query` parameter is sent directly to the remote host without validation or modification.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nReindexing from a remote server uses an on-heap buffer that defaults to a maximum size of 100mb.\nIf the remote index includes very large documents you'll need to use a smaller batch size.\nIt is also possible to set the socket read timeout on the remote connection with the `socket_timeout` field and the connection timeout with the `connect_timeout` field.\nBoth default to 30 seconds.\n\n**Configuring SSL parameters**\n\nReindex from remote supports configurable SSL settings.\nThese must be specified in the `elasticsearch.yml` file, with the exception of the secure settings, which you add in the Elasticsearch keystore.\nIt is not possible to configure SSL in the body of the reindex request.", + "examples": { + "ReindexRequestExample1": { + "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", + "summary": "Reindex multiple sources", + "value": "{\n \"source\": {\n \"index\": [\"my-index-000001\", \"my-index-000002\"]\n },\n \"dest\": {\n \"index\": \"my-new-index-000002\"\n }\n}" + }, + "ReindexRequestExample10": { + "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", + "summary": "Reindex with Painless", + "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": { + "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", + "summary": "Reindex a random subset", + "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": { + "description": "Run `POST _reindex` to modify documents during reindexing. This example bumps the version of the source document.\n", + "summary": "Reindex modified documents", + "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": { + "description": "When using Elastic Cloud, you can run `POST _reindex` and authenticate against a remote cluster with an API key.\n", + "summary": "Reindex from remote on Elastic Cloud", + "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": { + "description": "Run `POST _reindex` to slice a reindex request manually. Provide a slice ID and total number of slices to each request.\n", + "summary": "Manual slicing", + "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": { + "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", + "summary": "Automatic slicing", + "value": "{\n \"source\": {\n \"index\": \"my-index-000001\"\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\"\n }\n}" + }, + "ReindexRequestExample4": { + "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", + "summary": "Routing", + "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": { + "description": "Run `POST _reindex` and use the ingest pipelines feature.", + "summary": "Ingest pipelines", + "value": "{\n \"source\": {\n \"index\": \"source\"\n },\n \"dest\": {\n \"index\": \"dest\",\n \"pipeline\": \"some_ingest_pipeline\"\n }\n}" + }, + "ReindexRequestExample6": { + "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", + "summary": "Reindex with a query", + "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": { + "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", + "summary": "Reindex with max_docs", + "value": "{\n \"max_docs\": 1,\n \"source\": {\n \"index\": \"my-index-000001\"\n },\n \"dest\": {\n \"index\": \"my-new-index-000001\"\n }\n}" + }, + "ReindexRequestExample8": { + "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", + "summary": "Reindex selected fields", + "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": { + "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", + "summary": "Reindex new field names", + "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}" + } + }, + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "_global.reindex" + }, + "path": [], + "query": [ + { + "description": "If `true`, the request refreshes affected shards to make this operation visible to search.", + "name": "refresh", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The throttle for this request in sub-requests per second.\nBy default, there is no throttle.", + "name": "requests_per_second", + "required": false, + "serverDefault": -1, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + }, + { + "description": "The period of time that a consistent view of the index should be maintained for scrolled search.", + "name": "scroll", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "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.", + "extDocId": "slice-scroll", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#slice-scroll", + "name": "slices", + "required": false, + "serverDefault": "1", + "type": { + "kind": "instance_of", + "type": { + "name": "Slices", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "timeout", + "required": false, + "serverDefault": "1m", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "wait_for_active_shards", + "required": false, + "serverDefault": "1", + "type": { + "kind": "instance_of", + "type": { + "name": "WaitForActiveShards", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, the request blocks until the operation is complete.", + "name": "wait_for_completion", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, the destination must be an index alias.", + "name": "require_alias", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_global/reindex/ReindexRequest.ts#L27-L309" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "description": "The number of scroll responses that were pulled back by the reindex.", + "name": "batches", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "The number of documents that were successfully created.", + "name": "created", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "The number of documents that were successfully deleted.", + "name": "deleted", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "failures", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "BulkIndexByScrollFailure", + "namespace": "_types" + } + } + } + }, + { + "description": "The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`.", + "name": "noops", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "The number of retries attempted by reindex.", + "name": "retries", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Retries", + "namespace": "_types" + } + } + }, + { + "description": "The number of requests per second effectively run during the reindex.", + "name": "requests_per_second", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + }, + { + "name": "slice_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "task", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TaskId", + "namespace": "_types" + } + } + }, + { + "description": "The number of milliseconds the request slept to conform to `requests_per_second`.", + "name": "throttled_millis", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } + }, + { + "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`.", + "name": "throttled_until_millis", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } + }, + { + "description": "If any of the requests that ran during the reindex timed out, it is `true`.", + "name": "timed_out", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The total milliseconds the entire operation took.", + "name": "took", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "DurationValue", + "namespace": "_types" + } + } + }, + { + "description": "The number of documents that were successfully processed.", + "name": "total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "updated", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "The number of version conflicts that occurred.", + "name": "version_conflicts", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "_global.reindex" + }, + "specLocation": "_global/reindex/ReindexResponse.ts#L26-L92" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "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 ``.", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "file", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", + "name": "params", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "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.", + "name": "source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ] + }, + "description": "Render a search template.\n\nRender a search template as a search request body.", + "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}" + } + }, + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "_global.render_search_template" + }, + "path": [ + { + "description": "The ID of the search template to render.\nIf no `source` is specified, this or the `id` request body parameter is required.", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L76" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "template_output", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "_global.render_search_template" + }, + "specLocation": "_global/render_search_template/RenderSearchTemplateResponse.ts#L23-L25" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "The context that the script should run in.\nNOTE: Result ordering in the field contexts is not guaranteed.", + "name": "context", + "required": false, + "serverDefault": "painless_test", + "type": { + "kind": "instance_of", + "type": { + "name": "PainlessContext", + "namespace": "_global.scripts_painless_execute" + } + } + }, + { + "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`.", + "name": "context_setup", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "PainlessContextSetup", + "namespace": "_global.scripts_painless_execute" + } + } + }, + { + "description": "The Painless script to run.", + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } + } + ] + }, + "description": "Run a script.\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.", + "examples": { + "ExecutePainlessScriptRequestExample1": { + "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", + "summary": "Test context", + "value": "{\n \"script\": {\n \"source\": \"params.count / params.total\",\n \"params\": {\n \"count\": 100.0,\n \"total\": 1000.0\n }\n }\n}" + }, + "ExecutePainlessScriptRequestExample2": { + "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", + "summary": "Filter context", + "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": { + "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", + "summary": "Score context", + "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}" + } + }, + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "_global.scripts_painless_execute" + }, + "path": [], + "query": [], + "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts#L24-L64" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "TResult", + "namespace": "_global.scripts_painless_execute.Response" + } + } + } + ] + }, + "examples": { + "ExecutePainlessScriptResponseExample1": { + "description": "A successful response from `POST /_scripts/painless/_execute` with a `painless_test` context.", + "summary": "Test context", + "value": "{\n \"result\": \"0.1\"\n}" + }, + "ExecutePainlessScriptResponseExample2": { + "description": "A successful response from `POST /_scripts/painless/_execute` with a `filter` context.", + "summary": "Filter context", + "value": "{\n \"result\": true\n}" + }, + "ExecutePainlessScriptResponseExample3": { + "description": "A successful response from `POST /_scripts/painless/_execute` with a `score` context.", + "summary": "Score context", + "value": "{\n \"result\": 0.8\n}" + } + }, + "generics": [ + { + "name": "TResult", + "namespace": "_global.scripts_painless_execute.Response" + } + ], + "kind": "response", + "name": { + "name": "Response", + "namespace": "_global.scripts_painless_execute" + }, + "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptResponse.ts#L20-L24" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "The period to retain the search context for scrolling.", + "docId": "scroll-search-results", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "name": "scroll", + "required": false, + "serverDefault": "1d", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "The scroll ID of the search.", + "name": "scroll_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ScrollId", + "namespace": "_types" + } + } + } + ] + }, + "description": "Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", + "examples": { + "ScrollRequestExample1": { + "description": "Run `GET /_search/scroll` to get the next batch of results for a scrolling search.", + "value": "{\n \"scroll_id\" : \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}" + } + }, + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "_global.scroll" + }, + "path": [ + { + "deprecation": { + "description": "", + "version": "7.0.0" + }, + "description": "The scroll ID", + "name": "scroll_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ScrollId", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "The period to retain the search context for scrolling.", + "docId": "scroll-search-results", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "name": "scroll", + "required": false, + "serverDefault": "1d", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "deprecation": { + "description": "", + "version": "7.0.0" + }, + "description": "The scroll ID for scrolled search", + "name": "scroll_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ScrollId", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "rest_total_hits_as_int", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_global/scroll/ScrollRequest.ts#L24-L88" + }, + { + "body": { + "kind": "value", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.scroll.Response" + } + } ], "kind": "instance_of", "type": { @@ -55865,41 +57316,529 @@ }, "kind": "interface", "name": { - "name": "HasChildQuery", - "namespace": "_types.query_dsl" + "name": "HasChildQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.", + "name": "ignore_unmapped", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If defined, each search hit will contain inner hits.", + "docId": "inner-hits", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", + "name": "inner_hits", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InnerHits", + "namespace": "_global.search._types" + } + } + }, + { + "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.", + "name": "max_children", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "min_children", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Indicates how scores for matching child documents affect the root parent document’s relevance score.", + "name": "score_mode", + "required": false, + "serverDefault": "'none'", + "type": { + "kind": "instance_of", + "type": { + "name": "ChildScoreMode", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Name of the child relationship mapped for the `join` field.", + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "RelationName", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/query_dsl/joining.ts#L41-L79" + }, + { + "kind": "interface", + "name": { + "name": "InnerHits", + "namespace": "_global.search._types" + }, + "properties": [ + { + "description": "The name for the particular inner hit definition in the response.\nUseful when a search request contains multiple inner hits.", + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "description": "The maximum number of hits to return per `inner_hits`.", + "name": "size", + "required": false, + "serverDefault": 3, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Inner hit starting document offset.", + "name": "from", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "collapse", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FieldCollapse", + "namespace": "_global.search._types" + } + } + }, + { + "name": "docvalue_fields", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" + } + } + } + }, + { + "name": "explain", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "highlight", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Highlight", + "namespace": "_global.search._types" + } + } + }, + { + "name": "ignore_unmapped", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "script_fields", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ScriptField", + "namespace": "_types" + } + } + } + }, + { + "name": "seq_no_primary_term", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "How the inner hits should be sorted per `inner_hits`.\nBy default, inner hits are sorted by score.", + "name": "sort", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Sort", + "namespace": "_types" + } + } + }, + { + "name": "_source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SourceConfig", + "namespace": "_global.search._types" + } + } + }, + { + "name": "stored_fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "name": "track_scores", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_global/search/_types/hits.ts#L107-L141" + }, + { + "kind": "type_alias", + "name": { + "name": "Name", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L74-L74", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "extDocId": "collapse-search-results", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html", + "kind": "interface", + "name": { + "name": "FieldCollapse", + "namespace": "_global.search._types" + }, + "properties": [ + { + "description": "The field to collapse the result set on", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "The number of inner hits and their sort order", + "name": "inner_hits", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "InnerHits", + "namespace": "_global.search._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "InnerHits", + "namespace": "_global.search._types" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "The number of concurrent requests allowed to retrieve the inner_hits per group", + "name": "max_concurrent_group_searches", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "collapse", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FieldCollapse", + "namespace": "_global.search._types" + } + } + } + ], + "specLocation": "_global/search/_types/FieldCollapse.ts#L24-L41" + }, + { + "description": "A reference to a field with formatting instructions on how to return the value", + "kind": "interface", + "name": { + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "A wildcard pattern. The request returns values for field names matching this pattern.", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "The format in which the values are returned.", + "name": "format", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "include_unmapped", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "shortcutProperty": "field", + "specLocation": "_types/query_dsl/abstractions.ts#L535-L549" + }, + { + "inherits": { + "type": { + "name": "HighlightBase", + "namespace": "_global.search._types" + } + }, + "kind": "interface", + "name": { + "name": "Highlight", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "encoder", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "HighlighterEncoder", + "namespace": "_global.search._types" + } + } + }, + { + "name": "fields", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "HighlightField", + "namespace": "_global.search._types" + } + } + } + } + ], + "specLocation": "_global/search/_types/highlighting.ts#L152-L155" + }, + { + "kind": "interface", + "name": { + "name": "HighlightBase", + "namespace": "_global.search._types" }, "properties": [ { - "description": "Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.", - "name": "ignore_unmapped", + "name": "type", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "HighlighterType", + "namespace": "_global.search._types" } } }, { - "description": "If defined, each search hit will contain inner hits.", - "docId": "inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", - "name": "inner_hits", + "description": "A string that contains each boundary character.", + "name": "boundary_chars", "required": false, + "serverDefault": ".,!? \\t\\n", "type": { "kind": "instance_of", "type": { - "name": "InnerHits", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "max_children", + "description": "How far to scan for boundary characters.", + "name": "boundary_max_scan", "required": false, + "serverDefault": 20, "type": { "kind": "instance_of", "type": { @@ -55909,81 +57848,109 @@ } }, { - "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.", - "name": "min_children", + "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.", + "name": "boundary_scanner", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "BoundaryScanner", + "namespace": "_global.search._types" } } }, { - "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.", - "name": "query", - "required": true, + "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\"`.", + "name": "boundary_scanner_locale", + "required": false, + "serverDefault": "Locale.ROOT", "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Indicates how scores for matching child documents affect the root parent document’s relevance score.", - "name": "score_mode", + "deprecation": { + "description": "", + "version": "8.8.0" + }, + "name": "force_source", "required": false, - "serverDefault": "'none'", "type": { "kind": "instance_of", "type": { - "name": "ChildScoreMode", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Name of the child relationship mapped for the `join` field.", - "name": "type", - "required": true, + "description": "Specifies how text should be broken up in highlight snippets: `simple` or `span`.\nOnly valid for the `plain` highlighter.", + "name": "fragmenter", + "required": false, + "serverDefault": "span", "type": { "kind": "instance_of", "type": { - "name": "RelationName", + "name": "HighlighterFragmenter", + "namespace": "_global.search._types" + } + } + }, + { + "description": "The size of the highlighted fragment in characters.", + "name": "fragment_size", + "required": false, + "serverDefault": 100, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", "namespace": "_types" } } - } - ], - "specLocation": "_types/query_dsl/joining.ts#L41-L79" - }, - { - "kind": "interface", - "name": { - "name": "InnerHits", - "namespace": "_global.search._types" - }, - "properties": [ + }, { - "description": "The name for the particular inner hit definition in the response.\nUseful when a search request contains multiple inner hits.", - "name": "name", + "name": "highlight_filter", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "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.", + "name": "highlight_query", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "name": "max_fragment_length", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", "namespace": "_types" } } }, { - "description": "The maximum number of hits to return per `inner_hits`.", - "name": "size", + "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.", + "name": "max_analyzed_offset", "required": false, - "serverDefault": 3, "type": { "kind": "instance_of", "type": { @@ -55993,8 +57960,8 @@ } }, { - "description": "Inner hit starting document offset.", - "name": "from", + "description": "The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.", + "name": "no_match_size", "required": false, "serverDefault": 0, "type": { @@ -56006,88 +57973,97 @@ } }, { - "name": "collapse", + "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.", + "name": "number_of_fragments", "required": false, + "serverDefault": 5, "type": { "kind": "instance_of", "type": { - "name": "FieldCollapse", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "docvalue_fields", + "name": "options", "required": false, "type": { - "kind": "array_of", - "value": { + "key": { "kind": "instance_of", "type": { - "name": "FieldAndFormat", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "name": "explain", + "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.", + "name": "order", "required": false, + "serverDefault": "none", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "HighlighterOrder", + "namespace": "_global.search._types" } } }, { - "name": "highlight", + "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.", + "name": "phrase_limit", "required": false, + "serverDefault": 256, "type": { "kind": "instance_of", "type": { - "name": "Highlight", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "ignore_unmapped", + "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.", + "name": "post_tags", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "script_fields", + "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.", + "name": "pre_tags", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ScriptField", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } }, { - "name": "seq_no_primary_term", + "description": "By default, only fields that contains a query match are highlighted.\nSet to `false` to highlight all fields.", + "name": "require_field_match", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -56097,64 +58073,212 @@ } }, { - "name": "fields", + "description": "Set to `styled` to use the built-in tag schema.", + "name": "tags_schema", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", - "namespace": "_types" + "name": "HighlighterTagsSchema", + "namespace": "_global.search._types" } } + } + ], + "specLocation": "_global/search/_types/highlighting.ts#L47-L150" + }, + { + "isOpen": true, + "kind": "enum", + "members": [ + { + "description": "The `plain` highlighter uses the standard Lucene highlighter", + "name": "plain" }, { - "description": "How the inner hits should be sorted per `inner_hits`.\nBy default, inner hits are sorted by score.", - "name": "sort", + "codegenName": "fast_vector", + "description": "The fvh highlighter uses the Lucene Fast Vector highlighter.", + "name": "fvh" + }, + { + "description": "The unified highlighter uses the Lucene Unified Highlighter.", + "name": "unified" + } + ], + "name": { + "name": "HighlighterType", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/highlighting.ts#L175-L190" + }, + { + "kind": "enum", + "members": [ + { + "description": "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.", + "name": "chars" + }, + { + "description": "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.", + "name": "sentence" + }, + { + "description": "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`.", + "name": "word" + } + ], + "name": { + "name": "BoundaryScanner", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/highlighting.ts#L26-L45" + }, + { + "kind": "enum", + "members": [ + { + "name": "simple" + }, + { + "name": "span" + } + ], + "name": { + "name": "HighlighterFragmenter", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/highlighting.ts#L162-L165" + }, + { + "kind": "enum", + "members": [ + { + "name": "score" + } + ], + "name": { + "name": "HighlighterOrder", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/highlighting.ts#L167-L169" + }, + { + "kind": "enum", + "members": [ + { + "name": "styled" + } + ], + "name": { + "name": "HighlighterTagsSchema", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/highlighting.ts#L171-L173" + }, + { + "kind": "enum", + "members": [ + { + "name": "default" + }, + { + "name": "html" + } + ], + "name": { + "name": "HighlighterEncoder", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/highlighting.ts#L157-L160" + }, + { + "inherits": { + "type": { + "name": "HighlightBase", + "namespace": "_global.search._types" + } + }, + "kind": "interface", + "name": { + "name": "HighlightField", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "fragment_offset", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Sort", + "name": "integer", "namespace": "_types" } } }, { - "name": "_source", + "name": "matched_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SourceConfig", - "namespace": "_global.search._types" + "name": "Fields", + "namespace": "_types" } } - }, - { - "name": "stored_fields", - "required": false, - "type": { + } + ], + "specLocation": "_global/search/_types/highlighting.ts#L192-L195" + }, + { + "kind": "type_alias", + "name": { + "name": "Fields", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L137-L137", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "Fields", + "name": "Field", "namespace": "_types" } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "interface", + "name": { + "name": "ScriptField", + "namespace": "_types" + }, + "properties": [ { - "name": "track_scores", - "required": false, - "serverDefault": false, + "name": "script", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Script", + "namespace": "_types" } } }, { - "name": "version", + "name": "ignore_failure", "required": false, "type": { "kind": "instance_of", @@ -56165,254 +58289,235 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L107-L141" + "specLocation": "_types/Scripting.ts#L101-L104" }, { "kind": "type_alias", "name": { - "name": "Name", + "name": "Sort", "namespace": "_types" }, - "specLocation": "_types/common.ts#L74-L74", + "specLocation": "_types/sort.ts#L104-L104", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "SortCombinations", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SortCombinations", + "namespace": "_types" + } + } + } + ], + "kind": "union_of" } }, { - "extDocId": "collapse-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html", - "kind": "interface", + "codegenNames": [ + "field", + "options" + ], + "kind": "type_alias", "name": { - "name": "FieldCollapse", - "namespace": "_global.search._types" + "name": "SortCombinations", + "namespace": "_types" }, - "properties": [ - { - "description": "The field to collapse the result set on", - "name": "field", - "required": true, - "type": { + "specLocation": "_types/sort.ts#L98-L102", + "type": { + "items": [ + { "kind": "instance_of", "type": { "name": "Field", "namespace": "_types" } + }, + { + "kind": "instance_of", + "type": { + "name": "SortOptions", + "namespace": "_types" + } } - }, + ], + "kind": "union_of" + } + }, + { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ { - "description": "The number of inner hits and their sort order", - "name": "inner_hits", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "InnerHits", - "namespace": "_global.search._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "InnerHits", - "namespace": "_global.search._types" - } - } + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" } - ], - "kind": "union_of" + }, + { + "kind": "instance_of", + "type": { + "name": "FieldSort", + "namespace": "_types" + } + } + ], + "meta": { + "key": "field", + "value": "sort" + }, + "type": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" } - }, + } + ], + "docId": "sort-search-results", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "kind": "interface", + "name": { + "name": "SortOptions", + "namespace": "_types" + }, + "properties": [ { - "description": "The number of concurrent requests allowed to retrieve the inner_hits per group", - "name": "max_concurrent_group_searches", + "name": "_score", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ScoreSort", "namespace": "_types" } } }, { - "name": "collapse", + "name": "_doc", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldCollapse", - "namespace": "_global.search._types" - } - } - } - ], - "specLocation": "_global/search/_types/FieldCollapse.ts#L24-L41" - }, - { - "description": "A reference to a field with formatting instructions on how to return the value", - "kind": "interface", - "name": { - "name": "FieldAndFormat", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "description": "A wildcard pattern. The request returns values for field names matching this pattern.", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", + "name": "ScoreSort", "namespace": "_types" } } }, { - "description": "The format in which the values are returned.", - "name": "format", + "name": "_geo_distance", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "GeoDistanceSort", + "namespace": "_types" } } }, { - "name": "include_unmapped", + "name": "_script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ScriptSort", + "namespace": "_types" } } } ], - "shortcutProperty": "field", - "specLocation": "_types/query_dsl/abstractions.ts#L535-L549" + "specLocation": "_types/sort.ts#L86-L96", + "variants": { + "kind": "container" + } }, { - "inherits": { - "type": { - "name": "HighlightBase", - "namespace": "_global.search._types" - } - }, "kind": "interface", "name": { - "name": "Highlight", - "namespace": "_global.search._types" + "name": "FieldSort", + "namespace": "_types" }, "properties": [ { - "name": "encoder", + "name": "missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HighlighterEncoder", - "namespace": "_global.search._types" + "name": "Missing", + "namespace": "_types.aggregations" } } }, { - "name": "fields", - "required": true, + "name": "mode", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "HighlightField", - "namespace": "_global.search._types" - } + "kind": "instance_of", + "type": { + "name": "SortMode", + "namespace": "_types" } } - } - ], - "specLocation": "_global/search/_types/highlighting.ts#L152-L155" - }, - { - "kind": "interface", - "name": { - "name": "HighlightBase", - "namespace": "_global.search._types" - }, - "properties": [ + }, { - "name": "type", + "name": "nested", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HighlighterType", - "namespace": "_global.search._types" + "name": "NestedSortValue", + "namespace": "_types" } } }, { - "description": "A string that contains each boundary character.", - "name": "boundary_chars", + "name": "order", "required": false, - "serverDefault": ".,!? \\t\\n", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SortOrder", + "namespace": "_types" } } }, { - "description": "How far to scan for boundary characters.", - "name": "boundary_max_scan", + "name": "unmapped_type", "required": false, - "serverDefault": 20, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "FieldType", + "namespace": "_types.mapping" } } }, { - "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.", - "name": "boundary_scanner", + "name": "numeric_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "BoundaryScanner", - "namespace": "_global.search._types" + "name": "FieldSortNumericType", + "namespace": "_types" } } }, { - "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\"`.", - "name": "boundary_scanner_locale", + "name": "format", "required": false, - "serverDefault": "Locale.ROOT", "type": { "kind": "instance_of", "type": { @@ -56420,40 +58525,98 @@ "namespace": "_builtins" } } - }, - { - "deprecation": { - "description": "", - "version": "8.8.0" + } + ], + "shortcutProperty": "order", + "specLocation": "_types/sort.ts#L43-L52" + }, + { + "kind": "type_alias", + "name": { + "name": "Missing", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/AggregationContainer.ts#L535-L535", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } }, - "name": "force_source", - "required": false, - "type": { + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "name": "min" }, { - "description": "Specifies how text should be broken up in highlight snippets: `simple` or `span`.\nOnly valid for the `plain` highlighter.", - "name": "fragmenter", + "name": "max" + }, + { + "name": "sum" + }, + { + "name": "avg" + }, + { + "name": "median" + } + ], + "name": { + "name": "SortMode", + "namespace": "_types" + }, + "specLocation": "_types/sort.ts#L108-L117" + }, + { + "kind": "interface", + "name": { + "name": "NestedSortValue", + "namespace": "_types" + }, + "properties": [ + { + "name": "filter", "required": false, - "serverDefault": "span", "type": { "kind": "instance_of", "type": { - "name": "HighlighterFragmenter", - "namespace": "_global.search._types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "description": "The size of the highlighted fragment in characters.", - "name": "fragment_size", + "name": "max_children", "required": false, - "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -56463,345 +58626,523 @@ } }, { - "name": "highlight_filter", + "name": "nested", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "NestedSortValue", + "namespace": "_types" } } }, { - "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.", - "name": "highlight_query", - "required": false, + "name": "path", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "Field", + "namespace": "_types" } } + } + ], + "specLocation": "_types/sort.ts#L29-L34" + }, + { + "kind": "enum", + "members": [ + { + "description": "Ascending (smallest to largest)", + "name": "asc" }, { - "name": "max_fragment_length", + "description": "Descending (largest to smallest)", + "name": "desc" + } + ], + "name": { + "name": "SortOrder", + "namespace": "_types" + }, + "specLocation": "_types/sort.ts#L119-L128" + }, + { + "kind": "enum", + "members": [ + { + "name": "none" + }, + { + "name": "geo_point" + }, + { + "name": "geo_shape" + }, + { + "name": "ip" + }, + { + "name": "binary" + }, + { + "name": "keyword" + }, + { + "name": "text" + }, + { + "name": "search_as_you_type" + }, + { + "name": "date" + }, + { + "name": "date_nanos" + }, + { + "name": "boolean" + }, + { + "name": "completion" + }, + { + "name": "nested" + }, + { + "name": "object" + }, + { + "name": "passthrough" + }, + { + "name": "version" + }, + { + "name": "murmur3" + }, + { + "name": "token_count" + }, + { + "name": "percolator" + }, + { + "name": "integer" + }, + { + "name": "long" + }, + { + "name": "short" + }, + { + "name": "byte" + }, + { + "name": "float" + }, + { + "name": "half_float" + }, + { + "name": "scaled_float" + }, + { + "name": "double" + }, + { + "name": "integer_range" + }, + { + "name": "float_range" + }, + { + "name": "long_range" + }, + { + "name": "double_range" + }, + { + "name": "date_range" + }, + { + "name": "ip_range" + }, + { + "name": "alias" + }, + { + "name": "join" + }, + { + "name": "rank_feature" + }, + { + "name": "rank_features" + }, + { + "name": "flattened" + }, + { + "name": "shape" + }, + { + "name": "histogram" + }, + { + "name": "constant_keyword" + }, + { + "name": "counted_keyword" + }, + { + "name": "aggregate_metric_double" + }, + { + "name": "dense_vector" + }, + { + "name": "semantic_text" + }, + { + "name": "sparse_vector" + }, + { + "name": "match_only_text" + }, + { + "name": "icu_collation_keyword" + } + ], + "name": { + "name": "FieldType", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/Property.ts#L191-L240" + }, + { + "kind": "enum", + "members": [ + { + "name": "long" + }, + { + "name": "double" + }, + { + "name": "date" + }, + { + "name": "date_nanos" + } + ], + "name": { + "name": "FieldSortNumericType", + "namespace": "_types" + }, + "specLocation": "_types/sort.ts#L36-L41" + }, + { + "kind": "interface", + "name": { + "name": "ScoreSort", + "namespace": "_types" + }, + "properties": [ + { + "name": "order", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "SortOrder", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/sort.ts#L54-L56" + }, + { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ { - "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.", - "name": "max_analyzed_offset", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } + } + } + ], + "kind": "union_of" } + ], + "meta": { + "key": "field", + "value": "location" + }, + "type": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" } - }, + } + ], + "kind": "interface", + "name": { + "name": "GeoDistanceSort", + "namespace": "_types" + }, + "properties": [ { - "description": "The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.", - "name": "no_match_size", + "name": "mode", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "SortMode", "namespace": "_types" } } }, { - "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.", - "name": "number_of_fragments", + "name": "distance_type", "required": false, - "serverDefault": 5, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "GeoDistanceType", "namespace": "_types" } } }, { - "name": "options", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "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.", - "name": "order", + "name": "ignore_unmapped", "required": false, - "serverDefault": "none", "type": { "kind": "instance_of", "type": { - "name": "HighlighterOrder", - "namespace": "_global.search._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "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.", - "name": "phrase_limit", + "name": "order", "required": false, - "serverDefault": 256, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "SortOrder", "namespace": "_types" } } }, { - "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.", - "name": "post_tags", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "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.", - "name": "pre_tags", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "By default, only fields that contains a query match are highlighted.\nSet to `false` to highlight all fields.", - "name": "require_field_match", + "name": "unit", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DistanceUnit", + "namespace": "_types" } } }, { - "description": "Set to `styled` to use the built-in tag schema.", - "name": "tags_schema", + "name": "nested", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HighlighterTagsSchema", - "namespace": "_global.search._types" + "name": "NestedSortValue", + "namespace": "_types" } } } ], - "specLocation": "_global/search/_types/highlighting.ts#L47-L150" + "specLocation": "_types/sort.ts#L58-L70" }, { - "isOpen": true, "kind": "enum", "members": [ { - "description": "The `plain` highlighter uses the standard Lucene highlighter", - "name": "plain" + "codegenName": "inches", + "name": "in" }, { - "codegenName": "fast_vector", - "description": "The fvh highlighter uses the Lucene Fast Vector highlighter.", - "name": "fvh" + "codegenName": "feet", + "name": "ft" }, { - "description": "The unified highlighter uses the Lucene Unified Highlighter.", - "name": "unified" - } - ], - "name": { - "name": "HighlighterType", - "namespace": "_global.search._types" - }, - "specLocation": "_global/search/_types/highlighting.ts#L175-L190" - }, - { - "kind": "enum", - "members": [ - { - "description": "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.", - "name": "chars" + "codegenName": "yards", + "name": "yd" }, { - "description": "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.", - "name": "sentence" + "codegenName": "miles", + "name": "mi" }, { - "description": "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`.", - "name": "word" - } - ], - "name": { - "name": "BoundaryScanner", - "namespace": "_global.search._types" - }, - "specLocation": "_global/search/_types/highlighting.ts#L26-L45" - }, - { - "kind": "enum", - "members": [ - { - "name": "simple" + "codegenName": "nautic_miles", + "name": "nmi" }, { - "name": "span" - } - ], - "name": { - "name": "HighlighterFragmenter", - "namespace": "_global.search._types" - }, - "specLocation": "_global/search/_types/highlighting.ts#L162-L165" - }, - { - "kind": "enum", - "members": [ - { - "name": "score" - } - ], - "name": { - "name": "HighlighterOrder", - "namespace": "_global.search._types" - }, - "specLocation": "_global/search/_types/highlighting.ts#L167-L169" - }, - { - "kind": "enum", - "members": [ + "codegenName": "kilometers", + "name": "km" + }, { - "name": "styled" - } - ], - "name": { - "name": "HighlighterTagsSchema", - "namespace": "_global.search._types" - }, - "specLocation": "_global/search/_types/highlighting.ts#L171-L173" - }, - { - "kind": "enum", - "members": [ + "codegenName": "meters", + "name": "m" + }, { - "name": "default" + "codegenName": "centimeters", + "name": "cm" }, { - "name": "html" + "codegenName": "millimeters", + "name": "mm" } ], "name": { - "name": "HighlighterEncoder", - "namespace": "_global.search._types" + "name": "DistanceUnit", + "namespace": "_types" }, - "specLocation": "_global/search/_types/highlighting.ts#L157-L160" + "specLocation": "_types/Geo.ts#L30-L40" }, { - "inherits": { - "type": { - "name": "HighlightBase", - "namespace": "_global.search._types" - } - }, "kind": "interface", "name": { - "name": "HighlightField", - "namespace": "_global.search._types" + "name": "ScriptSort", + "namespace": "_types" }, "properties": [ { - "name": "fragment_offset", + "name": "order", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "SortOrder", "namespace": "_types" } } }, { - "name": "matched_fields", + "name": "script", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } + }, + { + "name": "type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "ScriptSortType", + "namespace": "_types" + } + } + }, + { + "name": "mode", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SortMode", + "namespace": "_types" + } + } + }, + { + "name": "nested", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NestedSortValue", "namespace": "_types" } } } ], - "specLocation": "_global/search/_types/highlighting.ts#L192-L195" + "specLocation": "_types/sort.ts#L72-L78" }, { - "kind": "type_alias", + "kind": "enum", + "members": [ + { + "name": "string" + }, + { + "name": "number" + }, + { + "name": "version" + } + ], "name": { - "name": "Fields", + "name": "ScriptSortType", "namespace": "_types" }, - "specLocation": "_types/common.ts#L137-L137", + "specLocation": "_types/sort.ts#L80-L84" + }, + { + "codegenNames": [ + "fetch", + "filter" + ], + "description": "Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.", + "kind": "type_alias", + "name": { + "name": "SourceConfig", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/SourceFilter.ts#L33-L37", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } }, { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "SourceFilter", + "namespace": "_global.search._types" } } ], @@ -56811,975 +59152,895 @@ { "kind": "interface", "name": { - "name": "ScriptField", - "namespace": "_types" + "name": "SourceFilter", + "namespace": "_global.search._types" }, "properties": [ { - "name": "script", - "required": true, + "aliases": [ + "exclude" + ], + "name": "excludes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "Fields", "namespace": "_types" } } }, { - "name": "ignore_failure", + "aliases": [ + "include" + ], + "name": "includes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Fields", + "namespace": "_types" } } } ], - "specLocation": "_types/Scripting.ts#L101-L104" + "shortcutProperty": "includes", + "specLocation": "_global/search/_types/SourceFilter.ts#L23-L31" }, { - "kind": "type_alias", + "kind": "enum", + "members": [ + { + "name": "none" + }, + { + "name": "avg" + }, + { + "name": "sum" + }, + { + "name": "max" + }, + { + "name": "min" + } + ], "name": { - "name": "Sort", - "namespace": "_types" + "name": "ChildScoreMode", + "namespace": "_types.query_dsl" }, - "specLocation": "_types/sort.ts#L104-L104", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "SortCombinations", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SortCombinations", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" - } + "specLocation": "_types/query_dsl/joining.ts#L25-L39" }, { - "codegenNames": [ - "field", - "options" - ], "kind": "type_alias", "name": { - "name": "SortCombinations", + "name": "RelationName", "namespace": "_types" }, - "specLocation": "_types/sort.ts#L98-L102", + "specLocation": "_types/common.ts#L128-L128", "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SortOptions", - "namespace": "_types" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "attachedBehaviors": [ - "AdditionalProperty" - ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "FieldSort", - "namespace": "_types" - } - } - ], - "meta": { - "key": "field", - "value": "sort" - }, - "type": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" - } + "extDocId": "query-dsl-has-parent-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-parent-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" } - ], - "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + }, "kind": "interface", "name": { - "name": "SortOptions", - "namespace": "_types" + "name": "HasParentQuery", + "namespace": "_types.query_dsl" }, "properties": [ { - "name": "_score", + "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`.", + "name": "ignore_unmapped", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "ScoreSort", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "_doc", + "description": "If defined, each search hit will contain inner hits.", + "docId": "inner-hits", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", + "name": "inner_hits", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ScoreSort", - "namespace": "_types" + "name": "InnerHits", + "namespace": "_global.search._types" } } }, { - "name": "_geo_distance", - "required": false, + "description": "Name of the parent relationship mapped for the `join` field.", + "name": "parent_type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "GeoDistanceSort", + "name": "RelationName", "namespace": "_types" } } }, { - "name": "_script", + "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.", + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Indicates whether the relevance score of a matching parent document is aggregated into its child documents.", + "name": "score", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/query_dsl/joining.ts#L81-L110" + }, + { + "extDocId": "query-dsl-ids-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "IdsQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "An array of document IDs.", + "name": "values", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ScriptSort", + "name": "Ids", "namespace": "_types" } } } ], - "specLocation": "_types/sort.ts#L86-L96", - "variants": { - "kind": "container" - } + "specLocation": "_types/query_dsl/term.ts#L88-L96" }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "FieldSort", + "name": "Ids", "namespace": "_types" }, - "properties": [ - { - "name": "missing", - "required": false, - "type": { + "specLocation": "_types/common.ts#L56-L56", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "Missing", - "namespace": "_types.aggregations" + "name": "Id", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } } - }, + ], + "kind": "union_of" + } + }, + { + "extDocId": "query-dsl-intervals-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "IntervalsQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "mode", + "description": "Returns matches that span a combination of other rules.", + "name": "all_of", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SortMode", - "namespace": "_types" + "name": "IntervalsAllOf", + "namespace": "_types.query_dsl" } } }, { - "name": "nested", + "description": "Returns intervals produced by any of its sub-rules.", + "name": "any_of", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NestedSortValue", - "namespace": "_types" + "name": "IntervalsAnyOf", + "namespace": "_types.query_dsl" } } }, { - "name": "order", + "description": "Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`.", + "docId": "fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "name": "fuzzy", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_types" + "name": "IntervalsFuzzy", + "namespace": "_types.query_dsl" } } }, { - "name": "unmapped_type", + "description": "Matches analyzed text.", + "name": "match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldType", - "namespace": "_types.mapping" + "name": "IntervalsMatch", + "namespace": "_types.query_dsl" } } }, { - "name": "numeric_type", + "description": "Matches terms that start with a specified set of characters.", + "name": "prefix", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldSortNumericType", - "namespace": "_types" + "name": "IntervalsPrefix", + "namespace": "_types.query_dsl" } } }, { - "name": "format", + "description": "Matches terms using a wildcard pattern.", + "name": "wildcard", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IntervalsWildcard", + "namespace": "_types.query_dsl" } } } ], - "shortcutProperty": "order", - "specLocation": "_types/sort.ts#L43-L52" + "specLocation": "_types/query_dsl/fulltext.ts#L235-L266", + "variants": { + "kind": "container" + } }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "Missing", - "namespace": "_types.aggregations" + "name": "IntervalsAllOf", + "namespace": "_types.query_dsl" }, - "specLocation": "_types/aggregations/AggregationContainer.ts#L535-L535", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "properties": [ + { + "description": "An array of rules to combine. All rules must produce a match in a document for the overall source to match.", + "name": "intervals", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" + } } - }, - { + } + }, + { + "description": "Maximum number of positions between the matching terms.\nIntervals produced by the rules further apart than this are not considered matches.", + "name": "max_gaps", + "required": false, + "serverDefault": -1, + "type": { "kind": "instance_of", "type": { "name": "integer", "namespace": "_types" } - }, - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { + } + }, + { + "description": "If `true`, intervals produced by the rules should appear in the order in which they are specified.", + "name": "ordered", + "required": false, + "serverDefault": false, + "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ - { - "name": "min" - }, - { - "name": "max" - }, - { - "name": "sum" - }, - { - "name": "avg" }, { - "name": "median" + "description": "Rule used to filter returned intervals.", + "name": "filter", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IntervalsFilter", + "namespace": "_types.query_dsl" + } + } } ], - "name": { - "name": "SortMode", - "namespace": "_types" - }, - "specLocation": "_types/sort.ts#L108-L117" + "specLocation": "_types/query_dsl/fulltext.ts#L50-L70" }, { "kind": "interface", "name": { - "name": "NestedSortValue", - "namespace": "_types" + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" }, "properties": [ { - "name": "filter", + "description": "Returns matches that span a combination of other rules.", + "name": "all_of", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", + "name": "IntervalsAllOf", "namespace": "_types.query_dsl" } } }, { - "name": "max_children", + "description": "Returns intervals produced by any of its sub-rules.", + "name": "any_of", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IntervalsAnyOf", + "namespace": "_types.query_dsl" } } }, { - "name": "nested", + "description": "Matches analyzed text.", + "name": "fuzzy", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NestedSortValue", - "namespace": "_types" + "name": "IntervalsFuzzy", + "namespace": "_types.query_dsl" } } }, { - "name": "path", - "required": true, + "description": "Matches analyzed text.", + "name": "match", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "IntervalsMatch", + "namespace": "_types.query_dsl" } } - } - ], - "specLocation": "_types/sort.ts#L29-L34" - }, - { - "kind": "enum", - "members": [ - { - "description": "Ascending (smallest to largest)", - "name": "asc" - }, - { - "description": "Descending (largest to smallest)", - "name": "desc" - } - ], - "name": { - "name": "SortOrder", - "namespace": "_types" - }, - "specLocation": "_types/sort.ts#L119-L128" - }, - { - "kind": "enum", - "members": [ - { - "name": "none" - }, - { - "name": "geo_point" - }, - { - "name": "geo_shape" - }, - { - "name": "ip" - }, - { - "name": "binary" - }, - { - "name": "keyword" - }, - { - "name": "text" - }, - { - "name": "search_as_you_type" - }, - { - "name": "date" - }, - { - "name": "date_nanos" - }, - { - "name": "boolean" - }, - { - "name": "completion" - }, - { - "name": "nested" - }, - { - "name": "object" - }, - { - "name": "passthrough" - }, - { - "name": "version" - }, - { - "name": "murmur3" - }, - { - "name": "token_count" - }, - { - "name": "percolator" - }, - { - "name": "integer" - }, - { - "name": "long" - }, - { - "name": "short" - }, - { - "name": "byte" - }, - { - "name": "float" - }, - { - "name": "half_float" - }, - { - "name": "scaled_float" - }, - { - "name": "double" - }, - { - "name": "integer_range" - }, - { - "name": "float_range" - }, - { - "name": "long_range" - }, - { - "name": "double_range" - }, - { - "name": "date_range" - }, - { - "name": "ip_range" - }, - { - "name": "alias" - }, - { - "name": "join" - }, - { - "name": "rank_feature" - }, - { - "name": "rank_features" - }, - { - "name": "flattened" - }, - { - "name": "shape" - }, - { - "name": "histogram" - }, - { - "name": "constant_keyword" - }, - { - "name": "counted_keyword" - }, - { - "name": "aggregate_metric_double" - }, - { - "name": "dense_vector" - }, - { - "name": "semantic_text" - }, - { - "name": "sparse_vector" - }, - { - "name": "match_only_text" - }, - { - "name": "icu_collation_keyword" - } - ], - "name": { - "name": "FieldType", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/Property.ts#L191-L240" - }, - { - "kind": "enum", - "members": [ - { - "name": "long" - }, - { - "name": "double" }, { - "name": "date" + "description": "Matches terms that start with a specified set of characters.", + "name": "prefix", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IntervalsPrefix", + "namespace": "_types.query_dsl" + } + } }, { - "name": "date_nanos" - } - ], - "name": { - "name": "FieldSortNumericType", - "namespace": "_types" - }, - "specLocation": "_types/sort.ts#L36-L41" - }, - { - "kind": "interface", - "name": { - "name": "ScoreSort", - "namespace": "_types" - }, - "properties": [ - { - "name": "order", + "description": "Matches terms using a wildcard pattern.", + "name": "wildcard", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_types" + "name": "IntervalsWildcard", + "namespace": "_types.query_dsl" } } } ], - "specLocation": "_types/sort.ts#L54-L56" + "specLocation": "_types/query_dsl/fulltext.ts#L83-L110", + "variants": { + "kind": "container" + } }, { - "attachedBehaviors": [ - "AdditionalProperty" - ], - "behaviors": [ + "kind": "interface", + "name": { + "name": "IntervalsAnyOf", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "generics": [ - { + "description": "An array of rules to match.", + "name": "intervals", + "required": true, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" } - }, - { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "GeoLocation", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "GeoLocation", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" } - ], - "meta": { - "key": "field", - "value": "location" - }, + } + }, + { + "description": "Rule used to filter returned intervals.", + "name": "filter", + "required": false, "type": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "IntervalsFilter", + "namespace": "_types.query_dsl" + } } } ], + "specLocation": "_types/query_dsl/fulltext.ts#L72-L81" + }, + { "kind": "interface", "name": { - "name": "GeoDistanceSort", - "namespace": "_types" + "name": "IntervalsFilter", + "namespace": "_types.query_dsl" }, "properties": [ { - "name": "mode", + "description": "Query used to return intervals that follow an interval from the `filter` rule.", + "name": "after", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SortMode", - "namespace": "_types" + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "distance_type", + "description": "Query used to return intervals that occur before an interval from the `filter` rule.", + "name": "before", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoDistanceType", - "namespace": "_types" + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "ignore_unmapped", + "description": "Query used to return intervals contained by an interval from the `filter` rule.", + "name": "contained_by", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "order", + "description": "Query used to return intervals that contain an interval from the `filter` rule.", + "name": "containing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_types" + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "unit", + "description": "Query used to return intervals that are **not** contained by an interval from the `filter` rule.", + "name": "not_contained_by", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DistanceUnit", - "namespace": "_types" + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "nested", + "description": "Query used to return intervals that do **not** contain an interval from the `filter` rule.", + "name": "not_containing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NestedSortValue", - "namespace": "_types" + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" } } - } - ], - "specLocation": "_types/sort.ts#L58-L70" - }, - { - "kind": "enum", - "members": [ - { - "codegenName": "inches", - "name": "in" - }, - { - "codegenName": "feet", - "name": "ft" - }, - { - "codegenName": "yards", - "name": "yd" - }, - { - "codegenName": "miles", - "name": "mi" - }, - { - "codegenName": "nautic_miles", - "name": "nmi" - }, - { - "codegenName": "kilometers", - "name": "km" }, { - "codegenName": "meters", - "name": "m" + "description": "Query used to return intervals that do **not** overlap with an interval from the `filter` rule.", + "name": "not_overlapping", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" + } + } }, { - "codegenName": "centimeters", - "name": "cm" + "description": "Query used to return intervals that overlap with an interval from the `filter` rule.", + "name": "overlapping", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IntervalsContainer", + "namespace": "_types.query_dsl" + } + } }, { - "codegenName": "millimeters", - "name": "mm" + "description": "Script used to return matching documents.\nThis script must return a boolean value: `true` or `false`.", + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } } ], - "name": { - "name": "DistanceUnit", - "namespace": "_types" - }, - "specLocation": "_types/Geo.ts#L30-L40" + "specLocation": "_types/query_dsl/fulltext.ts#L112-L152", + "variants": { + "kind": "container" + } }, { "kind": "interface", "name": { - "name": "ScriptSort", - "namespace": "_types" + "name": "IntervalsFuzzy", + "namespace": "_types.query_dsl" }, "properties": [ { - "name": "order", + "description": "Analyzer used to normalize the term.", + "docId": "analysis", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "script", - "required": true, + "description": "Maximum edit distance allowed for matching.", + "name": "fuzziness", + "required": false, + "serverDefault": "auto", "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "Fuzziness", "namespace": "_types" } } }, { - "name": "type", + "description": "Number of beginning characters left unchanged when creating expansions.", + "name": "prefix_length", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "ScriptSortType", + "name": "integer", "namespace": "_types" } } }, { - "name": "mode", + "description": "The term to match.", + "name": "term", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`).", + "name": "transpositions", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "SortMode", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "nested", + "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.", + "name": "use_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NestedSortValue", + "name": "Field", "namespace": "_types" } } } ], - "specLocation": "_types/sort.ts#L72-L78" + "specLocation": "_types/query_dsl/fulltext.ts#L154-L184" }, { - "kind": "enum", - "members": [ + "kind": "interface", + "name": { + "name": "IntervalsMatch", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "string" + "description": "Analyzer used to analyze terms in the query.", + "docId": "analysis", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "number" + "description": "Maximum number of positions between the matching terms.\nTerms further apart than this are not considered matches.", + "name": "max_gaps", + "required": false, + "serverDefault": -1, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "name": "version" - } - ], - "name": { - "name": "ScriptSortType", - "namespace": "_types" - }, - "specLocation": "_types/sort.ts#L80-L84" - }, - { - "codegenNames": [ - "fetch", - "filter" - ], - "description": "Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.", - "kind": "type_alias", - "name": { - "name": "SourceConfig", - "namespace": "_global.search._types" - }, - "specLocation": "_global/search/_types/SourceFilter.ts#L33-L37", - "type": { - "items": [ - { + "description": "If `true`, matching terms must appear in their specified order.", + "name": "ordered", + "required": false, + "serverDefault": false, + "type": { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } - }, - { + } + }, + { + "description": "Text you wish to find in the provided field.", + "name": "query", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "SourceFilter", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } + }, + { + "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.", + "name": "use_field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "An optional interval filter.", + "name": "filter", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IntervalsFilter", + "namespace": "_types.query_dsl" + } + } + } + ], + "specLocation": "_types/query_dsl/fulltext.ts#L186-L216" }, { "kind": "interface", "name": { - "name": "SourceFilter", - "namespace": "_global.search._types" + "name": "IntervalsPrefix", + "namespace": "_types.query_dsl" }, "properties": [ { - "aliases": [ - "exclude" - ], - "name": "excludes", + "description": "Analyzer used to analyze the `prefix`.", + "docId": "analysis", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "include" - ], - "name": "includes", + "description": "Beginning characters of terms you wish to find in the top-level field.", + "name": "prefix", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "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.", + "name": "use_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "Field", "namespace": "_types" } } } ], - "shortcutProperty": "includes", - "specLocation": "_global/search/_types/SourceFilter.ts#L23-L31" + "specLocation": "_types/query_dsl/fulltext.ts#L218-L233" }, { - "kind": "enum", - "members": [ - { - "name": "none" - }, - { - "name": "avg" - }, + "kind": "interface", + "name": { + "name": "IntervalsWildcard", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "name": "sum" + "description": "Analyzer used to analyze the `pattern`.\nDefaults to the top-level field's analyzer.", + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "max" + "description": "Wildcard pattern used to find matching terms.", + "name": "pattern", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "min" + "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.", + "name": "use_field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } } ], - "name": { - "name": "ChildScoreMode", - "namespace": "_types.query_dsl" - }, - "specLocation": "_types/query_dsl/joining.ts#L25-L39" - }, - { - "kind": "type_alias", - "name": { - "name": "RelationName", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L128-L128", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "specLocation": "_types/query_dsl/fulltext.ts#L268-L283" }, { - "extDocId": "query-dsl-has-parent-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-parent-query.html", + "extDocId": "query-dsl-knn-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-knn-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57788,140 +60049,232 @@ }, "kind": "interface", "name": { - "name": "HasParentQuery", - "namespace": "_types.query_dsl" + "name": "KnnQuery", + "namespace": "_types" }, "properties": [ { - "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`.", - "name": "ignore_unmapped", + "description": "The name of the vector field to search against", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "The query vector", + "name": "query_vector", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "QueryVector", + "namespace": "_types" } } }, { - "description": "If defined, each search hit will contain inner hits.", - "docId": "inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", - "name": "inner_hits", + "description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.", + "name": "query_vector_builder", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryVectorBuilder", + "namespace": "_types" + } + } + }, + { + "description": "The number of nearest neighbor candidates to consider per shard", + "name": "num_candidates", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The final number of nearest neighbors to return as top hits", + "name": "k", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Filters for the kNN search query", + "name": "filter", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "The minimum similarity for a vector to be considered a match", + "name": "similarity", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + }, + { + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "since": "8.18.0", + "stability": "experimental" + } + }, + "description": "Apply oversampling and rescoring to quantized vectors *", + "name": "rescore_vector", "required": false, "type": { "kind": "instance_of", "type": { - "name": "InnerHits", - "namespace": "_global.search._types" + "name": "RescoreVector", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/Knn.ts#L64-L87" + }, + { + "kind": "type_alias", + "name": { + "name": "QueryVector", + "namespace": "_types" + }, + "specLocation": "_types/Knn.ts#L25-L25", + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + } + }, + { + "kind": "interface", + "name": { + "name": "QueryVectorBuilder", + "namespace": "_types" + }, + "properties": [ { - "description": "Name of the parent relationship mapped for the `join` field.", - "name": "parent_type", - "required": true, + "name": "text_embedding", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "RelationName", + "name": "TextEmbedding", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/Knn.ts#L89-L92", + "variants": { + "kind": "container" + } + }, + { + "kind": "interface", + "name": { + "name": "TextEmbedding", + "namespace": "_types" + }, + "properties": [ { - "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.", - "name": "query", + "name": "model_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Indicates whether the relevance score of a matching parent document is aggregated into its child documents.", - "name": "score", - "required": false, - "serverDefault": false, + "name": "model_text", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "_types/query_dsl/joining.ts#L81-L110" + "specLocation": "_types/Knn.ts#L94-L97" }, { - "extDocId": "query-dsl-ids-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, "kind": "interface", "name": { - "name": "IdsQuery", - "namespace": "_types.query_dsl" + "name": "RescoreVector", + "namespace": "_types" }, "properties": [ { - "description": "An array of document IDs.", - "name": "values", - "required": false, + "description": "Applies the specified oversample factor to k on the approximate kNN search", + "name": "oversample", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "float", "namespace": "_types" } } } ], - "specLocation": "_types/query_dsl/term.ts#L88-L96" - }, - { - "kind": "type_alias", - "name": { - "name": "Ids", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L56-L56", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" - } + "specLocation": "_types/Knn.ts#L30-L33" }, { - "extDocId": "query-dsl-intervals-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html", + "extDocId": "query-dsl-match-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57930,128 +60283,96 @@ }, "kind": "interface", "name": { - "name": "IntervalsQuery", + "name": "MatchQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Returns matches that span a combination of other rules.", - "name": "all_of", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IntervalsAllOf", - "namespace": "_types.query_dsl" - } - } - }, - { - "description": "Returns intervals produced by any of its sub-rules.", - "name": "any_of", + "description": "Analyzer used to convert the text in the query value into tokens.", + "docId": "analysis", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsAnyOf", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`.", - "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", - "name": "fuzzy", + "description": "If `true`, match phrase queries are automatically created for multi-term synonyms.", + "name": "auto_generate_synonyms_phrase_query", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "IntervalsFuzzy", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Matches analyzed text.", - "name": "match", + "deprecation": { + "description": "", + "version": "7.3.0" + }, + "name": "cutoff_frequency", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsMatch", - "namespace": "_types.query_dsl" + "name": "double", + "namespace": "_types" } } }, { - "description": "Matches terms that start with a specified set of characters.", - "name": "prefix", + "description": "Maximum edit distance allowed for matching.", + "docId": "fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "name": "fuzziness", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsPrefix", - "namespace": "_types.query_dsl" + "name": "Fuzziness", + "namespace": "_types" } } }, { - "description": "Matches terms using a wildcard pattern.", - "name": "wildcard", + "description": "Method used to rewrite the query.", + "docId": "query-dsl-multi-term-rewrite", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "name": "fuzzy_rewrite", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsWildcard", - "namespace": "_types.query_dsl" - } - } - } - ], - "specLocation": "_types/query_dsl/fulltext.ts#L235-L266", - "variants": { - "kind": "container" - } - }, - { - "kind": "interface", - "name": { - "name": "IntervalsAllOf", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "description": "An array of rules to combine. All rules must produce a match in a document for the overall source to match.", - "name": "intervals", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" - } + "name": "MultiTermQueryRewrite", + "namespace": "_types" } } }, { - "description": "Maximum number of positions between the matching terms.\nIntervals produced by the rules further apart than this are not considered matches.", - "name": "max_gaps", + "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", + "name": "fuzzy_transpositions", "required": false, - "serverDefault": -1, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "If `true`, intervals produced by the rules should appear in the order in which they are specified.", - "name": "ordered", + "description": "If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.", + "name": "lenient", "required": false, "serverDefault": false, "type": { @@ -58063,272 +60384,314 @@ } }, { - "description": "Rule used to filter returned intervals.", - "name": "filter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IntervalsFilter", - "namespace": "_types.query_dsl" - } - } - } - ], - "specLocation": "_types/query_dsl/fulltext.ts#L50-L70" - }, - { - "kind": "interface", - "name": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "description": "Returns matches that span a combination of other rules.", - "name": "all_of", + "description": "Maximum number of terms to which the query will expand.", + "name": "max_expansions", "required": false, + "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "IntervalsAllOf", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Returns intervals produced by any of its sub-rules.", - "name": "any_of", + "description": "Minimum number of clauses that must match for a document to be returned.", + "docId": "query-dsl-minimum-should-match", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "name": "minimum_should_match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsAnyOf", - "namespace": "_types.query_dsl" + "name": "MinimumShouldMatch", + "namespace": "_types" } } }, { - "description": "Matches analyzed text.", - "name": "fuzzy", + "description": "Boolean logic used to interpret text in the query value.", + "name": "operator", "required": false, + "serverDefault": "'or'", "type": { "kind": "instance_of", "type": { - "name": "IntervalsFuzzy", + "name": "Operator", "namespace": "_types.query_dsl" } } }, { - "description": "Matches analyzed text.", - "name": "match", + "description": "Number of beginning characters left unchanged for fuzzy matching.", + "name": "prefix_length", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "IntervalsMatch", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Matches terms that start with a specified set of characters.", - "name": "prefix", - "required": false, + "description": "Text, number, boolean value or date you wish to find in the provided field.", + "name": "query", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "IntervalsPrefix", - "namespace": "_types.query_dsl" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "Matches terms using a wildcard pattern.", - "name": "wildcard", + "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", + "name": "zero_terms_query", "required": false, + "serverDefault": "'none'", "type": { "kind": "instance_of", "type": { - "name": "IntervalsWildcard", + "name": "ZeroTermsQuery", "namespace": "_types.query_dsl" } } } ], - "specLocation": "_types/query_dsl/fulltext.ts#L83-L110", - "variants": { - "kind": "container" - } + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L285-L353" }, { - "kind": "interface", - "name": { - "name": "IntervalsAnyOf", - "namespace": "_types.query_dsl" - }, - "properties": [ + "kind": "enum", + "members": [ { - "description": "An array of rules to match.", - "name": "intervals", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" - } - } - } + "description": "Returns all documents, similar to a `match_all` query.", + "name": "all" }, { - "description": "Rule used to filter returned intervals.", - "name": "filter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IntervalsFilter", - "namespace": "_types.query_dsl" - } - } + "description": "No documents are returned if the `analyzer` removes all tokens.", + "name": "none" } ], - "specLocation": "_types/query_dsl/fulltext.ts#L72-L81" + "name": { + "name": "ZeroTermsQuery", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/fulltext.ts#L587-L596" }, { + "extDocId": "query-dsl-match-all-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "IntervalsFilter", + "name": "MatchAllQuery", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/MatchAllQuery.ts#L22-L25" + }, + { + "extDocId": "query-dsl-match-bool-prefix-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-bool-prefix-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchBoolPrefixQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Query used to return intervals that follow an interval from the `filter` rule.", - "name": "after", + "description": "Analyzer used to convert the text in the query value into tokens.", + "docId": "analysis", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Query used to return intervals that occur before an interval from the `filter` rule.", - "name": "before", + "description": "Maximum edit distance allowed for matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", + "docId": "fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "name": "fuzziness", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "Fuzziness", + "namespace": "_types" } } }, { - "description": "Query used to return intervals contained by an interval from the `filter` rule.", - "name": "contained_by", + "description": "Method used to rewrite the query.\nCan be applied to the term subqueries constructed for all terms but the final term.", + "docId": "query-dsl-multi-term-rewrite", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "name": "fuzzy_rewrite", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "MultiTermQueryRewrite", + "namespace": "_types" } } }, { - "description": "Query used to return intervals that contain an interval from the `filter` rule.", - "name": "containing", + "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.", + "name": "fuzzy_transpositions", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Query used to return intervals that are **not** contained by an interval from the `filter` rule.", - "name": "not_contained_by", + "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.", + "name": "max_expansions", "required": false, + "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Query used to return intervals that do **not** contain an interval from the `filter` rule.", - "name": "not_containing", + "description": "Minimum number of clauses that must match for a document to be returned.\nApplied to the constructed bool query.", + "docId": "query-dsl-minimum-should-match", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "name": "minimum_should_match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "MinimumShouldMatch", + "namespace": "_types" } } }, { - "description": "Query used to return intervals that do **not** overlap with an interval from the `filter` rule.", - "name": "not_overlapping", + "description": "Boolean logic used to interpret text in the query value.\nApplied to the constructed bool query.", + "name": "operator", "required": false, + "serverDefault": "'or'", "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", + "name": "Operator", "namespace": "_types.query_dsl" } } }, { - "description": "Query used to return intervals that overlap with an interval from the `filter` rule.", - "name": "overlapping", + "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.", + "name": "prefix_length", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "IntervalsContainer", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Script used to return matching documents.\nThis script must return a boolean value: `true` or `false`.", - "name": "script", - "required": false, + "description": "Terms you wish to find in the provided field.\nThe last term is used in a prefix query.", + "name": "query", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/query_dsl/fulltext.ts#L112-L152", - "variants": { - "kind": "container" - } + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L355-L412" + }, + { + "extDocId": "query-dsl-match-none-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html#query-dsl-match-none-query", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "MatchNoneQuery", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/MatchNoneQuery.ts#L22-L25" }, { + "extDocId": "query-dsl-match-query-phrase", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "IntervalsFuzzy", + "name": "MatchPhraseQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Analyzer used to normalize the term.", + "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", "name": "analyzer", @@ -58342,34 +60705,8 @@ } }, { - "description": "Maximum edit distance allowed for matching.", - "name": "fuzziness", - "required": false, - "serverDefault": "auto", - "type": { - "kind": "instance_of", - "type": { - "name": "Fuzziness", - "namespace": "_types" - } - } - }, - { - "description": "Number of beginning characters left unchanged when creating expansions.", - "name": "prefix_length", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The term to match.", - "name": "term", + "description": "Query terms that are analyzed and turned into a phrase query.", + "name": "query", "required": true, "type": { "kind": "instance_of", @@ -58380,42 +60717,52 @@ } }, { - "description": "Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`).", - "name": "transpositions", + "description": "Maximum number of positions allowed between matching tokens.", + "name": "slop", "required": false, - "serverDefault": true, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "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.", - "name": "use_field", + "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", + "name": "zero_terms_query", "required": false, + "serverDefault": "'none'", "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "ZeroTermsQuery", + "namespace": "_types.query_dsl" } } } ], - "specLocation": "_types/query_dsl/fulltext.ts#L154-L184" + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L414-L438" }, { + "extDocId": "query-dsl-match-query-phrase-prefix", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "IntervalsMatch", + "name": "MatchPhrasePrefixQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Analyzer used to analyze terms in the query.", + "description": "Analyzer used to convert text in the query value into tokens.", "docId": "analysis", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", "name": "analyzer", @@ -58429,10 +60776,10 @@ } }, { - "description": "Maximum number of positions between the matching terms.\nTerms further apart than this are not considered matches.", - "name": "max_gaps", + "description": "Maximum number of terms to which the last provided term of the query value will expand.", + "name": "max_expansions", "required": false, - "serverDefault": -1, + "serverDefault": 50, "type": { "kind": "instance_of", "type": { @@ -58441,19 +60788,6 @@ } } }, - { - "description": "If `true`, matching terms must appear in their specified order.", - "name": "ordered", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, { "description": "Text you wish to find in the provided field.", "name": "query", @@ -58467,43 +60801,54 @@ } }, { - "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.", - "name": "use_field", + "description": "Maximum number of positions allowed between matching tokens.", + "name": "slop", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "integer", "namespace": "_types" } } }, { - "description": "An optional interval filter.", - "name": "filter", + "description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.", + "name": "zero_terms_query", "required": false, + "serverDefault": "none", "type": { "kind": "instance_of", "type": { - "name": "IntervalsFilter", + "name": "ZeroTermsQuery", "namespace": "_types.query_dsl" } } } ], - "specLocation": "_types/query_dsl/fulltext.ts#L186-L216" + "shortcutProperty": "query", + "specLocation": "_types/query_dsl/fulltext.ts#L440-L469" }, { + "extDocId": "query-dsl-mlt-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "IntervalsPrefix", + "name": "MoreLikeThisQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Analyzer used to analyze the `prefix`.", - "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.", + "extDocId": "analysis", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", "name": "analyzer", "required": false, "type": { @@ -58515,133 +60860,156 @@ } }, { - "description": "Beginning characters of terms you wish to find in the top-level field.", - "name": "prefix", - "required": true, + "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).", + "name": "boost_terms", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "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.", - "name": "use_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`).", + "name": "fail_on_unsupported_field", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/query_dsl/fulltext.ts#L218-L233" - }, - { - "kind": "interface", - "name": { - "name": "IntervalsWildcard", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "description": "Analyzer used to analyze the `pattern`.\nDefaults to the top-level field's analyzer.", - "name": "analyzer", + "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 `*`.", + "name": "fields", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + } + }, + { + "description": "Specifies whether the input documents should also be included in the search results returned.", + "name": "include", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "Wildcard pattern used to find matching terms.", - "name": "pattern", + "description": "Specifies free form text and/or a single or multiple documents for which you want to find similar documents.", + "name": "like", "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Like", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Like", + "namespace": "_types.query_dsl" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "The maximum document frequency above which the terms are ignored from the input document.", + "name": "max_doc_freq", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "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.", - "name": "use_field", + "description": "The maximum number of query terms that can be selected.", + "name": "max_query_terms", "required": false, + "serverDefault": 25, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "integer", "namespace": "_types" } } - } - ], - "specLocation": "_types/query_dsl/fulltext.ts#L268-L283" - }, - { - "extDocId": "query-dsl-knn-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-knn-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "KnnQuery", - "namespace": "_types" - }, - "properties": [ + }, { - "description": "The name of the vector field to search against", - "name": "field", - "required": true, + "description": "The maximum word length above which the terms are ignored.\nDefaults to unbounded (`0`).", + "name": "max_word_length", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "integer", "namespace": "_types" } } }, { - "description": "The query vector", - "name": "query_vector", + "description": "The minimum document frequency below which the terms are ignored from the input document.", + "name": "min_doc_freq", "required": false, + "serverDefault": 5, "type": { "kind": "instance_of", "type": { - "name": "QueryVector", + "name": "integer", "namespace": "_types" } } }, { - "description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.", - "name": "query_vector_builder", + "description": "After the disjunctive query has been formed, this parameter controls the number of terms that must match.", + "docId": "query-dsl-minimum-should-match", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "name": "minimum_should_match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryVectorBuilder", + "name": "MinimumShouldMatch", "namespace": "_types" } } }, { - "description": "The number of nearest neighbor candidates to consider per shard", - "name": "num_candidates", + "description": "The minimum term frequency below which the terms are ignored from the input document.", + "name": "min_term_freq", "required": false, + "serverDefault": 2, "type": { "kind": "instance_of", "type": { @@ -58651,9 +61019,10 @@ } }, { - "description": "The final number of nearest neighbors to return as top hits", - "name": "k", + "description": "The minimum word length below which the terms are ignored.", + "name": "min_word_length", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -58663,15 +61032,38 @@ } }, { - "description": "Filters for the kNN search query", - "name": "filter", + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" + } + } + }, + { + "description": "An array of stop words.\nAny word in this set is ignored.", + "name": "stop_words", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } + }, + { + "description": "Used in combination with `like` to exclude documents that match a set of terms.", + "name": "unlike", "required": false, "type": { "items": [ { "kind": "instance_of", "type": { - "name": "QueryContainer", + "name": "Like", "namespace": "_types.query_dsl" } }, @@ -58680,7 +61072,7 @@ "value": { "kind": "instance_of", "type": { - "name": "QueryContainer", + "name": "Like", "namespace": "_types.query_dsl" } } @@ -58690,140 +61082,238 @@ } }, { - "description": "The minimum similarity for a vector to be considered a match", - "name": "similarity", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "VersionNumber", "namespace": "_types" } } }, { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "since": "8.18.0", - "stability": "experimental" - } - }, - "description": "Apply oversampling and rescoring to quantized vectors *", - "name": "rescore_vector", + "name": "version_type", "required": false, + "serverDefault": "'internal'", "type": { "kind": "instance_of", "type": { - "name": "RescoreVector", + "name": "VersionType", "namespace": "_types" } } } ], - "specLocation": "_types/Knn.ts#L64-L87" + "specLocation": "_types/query_dsl/specialized.ts#L87-L172" }, { + "codegenNames": [ + "text", + "document" + ], + "description": "Text that we want similar documents for or a lookup to a document's field for the text.", + "docId": "document-input-parameters", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", "kind": "type_alias", "name": { - "name": "QueryVector", - "namespace": "_types" + "name": "Like", + "namespace": "_types.query_dsl" }, - "specLocation": "_types/Knn.ts#L25-L25", + "specLocation": "_types/query_dsl/specialized.ts#L198-L203", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "LikeDocument", + "namespace": "_types.query_dsl" + } } - } + ], + "kind": "union_of" } }, { "kind": "interface", "name": { - "name": "QueryVectorBuilder", - "namespace": "_types" + "name": "LikeDocument", + "namespace": "_types.query_dsl" }, "properties": [ { - "name": "text_embedding", + "description": "A document not present in the index.", + "name": "doc", + "required": false, + "type": { + "kind": "user_defined_value" + } + }, + { + "name": "fields", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + } + }, + { + "description": "ID of a document.", + "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TextEmbedding", + "name": "Id", "namespace": "_types" } } - } - ], - "specLocation": "_types/Knn.ts#L89-L92", - "variants": { - "kind": "container" - } - }, - { - "kind": "interface", - "name": { - "name": "TextEmbedding", - "namespace": "_types" - }, - "properties": [ + }, { - "name": "model_id", - "required": true, + "description": "Index of a document.", + "name": "_index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } }, { - "name": "model_text", - "required": true, + "description": "Overrides the default analyzer.", + "name": "per_field_analyzer", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "routing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Routing", + "namespace": "_types" + } + } + }, + { + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + }, + { + "name": "version_type", + "required": false, + "serverDefault": "'internal'", + "type": { + "kind": "instance_of", + "type": { + "name": "VersionType", + "namespace": "_types" } } } ], - "specLocation": "_types/Knn.ts#L94-L97" + "specLocation": "_types/query_dsl/specialized.ts#L174-L196" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "description": "Use internal versioning that starts at 1 and increments with each update or delete.", + "name": "internal" + }, + { + "description": "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.", + "name": "external" + }, + { + "description": "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.", + "name": "external_gte" + }, + { + "description": "This option is deprecated because it can cause primary and replica shards to diverge.", + "name": "force" + } + ], + "name": { + "name": "VersionType", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L100-L119" + }, + { + "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.", + "kind": "type_alias", "name": { - "name": "RescoreVector", - "namespace": "_types" + "name": "StopWords", + "namespace": "_types.analysis" }, - "properties": [ - { - "description": "Applies the specified oversample factor to k on the approximate kNN search", - "name": "oversample", - "required": true, - "type": { + "specLocation": "_types/analysis/StopWords.ts#L20-L26", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - } - ], - "specLocation": "_types/Knn.ts#L30-L33" + ], + "kind": "union_of" + } }, { - "extDocId": "query-dsl-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "extDocId": "query-dsl-multi-match-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html", "inherits": { "type": { "name": "QueryBase", @@ -58832,7 +61322,7 @@ }, "kind": "interface", "name": { - "name": "MatchQuery", + "name": "MultiMatchQuery", "namespace": "_types.query_dsl" }, "properties": [ @@ -58878,6 +61368,18 @@ } } }, + { + "description": "The fields to be queried.\nDefaults to the `index.query.default_field` index settings, which in turn defaults to `*`.", + "name": "fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, { "description": "Maximum edit distance allowed for matching.", "docId": "fuzziness", @@ -58907,7 +61409,7 @@ } }, { - "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", + "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.", "name": "fuzzy_transpositions", "required": false, "serverDefault": true, @@ -58990,30 +61492,50 @@ "name": "query", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Maximum number of positions allowed between matching tokens.", + "name": "slop", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Determines how scores for each per-term blended query and scores across groups are combined.", + "name": "tie_breaker", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "description": "How `the` multi_match query is executed internally.", + "name": "type", + "required": false, + "serverDefault": "'best_fields'", + "type": { + "kind": "instance_of", + "type": { + "name": "TextQueryType", + "namespace": "_types.query_dsl" + } } }, { @@ -59030,30 +61552,45 @@ } } ], - "shortcutProperty": "query", - "specLocation": "_types/query_dsl/fulltext.ts#L285-L353" + "specLocation": "_types/query_dsl/fulltext.ts#L471-L557" }, { "kind": "enum", "members": [ { - "description": "Returns all documents, similar to a `match_all` query.", - "name": "all" + "description": "Finds documents that match any field, but uses the `_score` from the best field.", + "name": "best_fields" }, { - "description": "No documents are returned if the `analyzer` removes all tokens.", - "name": "none" + "description": "Finds documents that match any field and combines the `_score` from each field.", + "name": "most_fields" + }, + { + "description": "Treats fields with the same analyzer as though they were one big field.\nLooks for each word in any field.", + "name": "cross_fields" + }, + { + "description": "Runs a `match_phrase` query on each field and uses the `_score` from the best field.", + "name": "phrase" + }, + { + "description": "Runs a `match_phrase_prefix` query on each field and uses the `_score` from the best field.", + "name": "phrase_prefix" + }, + { + "description": "Creates a `match_bool_prefix` query on each field and combines the `_score` from each field.", + "name": "bool_prefix" } ], "name": { - "name": "ZeroTermsQuery", + "name": "TextQueryType", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/fulltext.ts#L587-L596" + "specLocation": "_types/query_dsl/fulltext.ts#L559-L585" }, { - "extDocId": "query-dsl-match-all-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "extDocId": "query-dsl-nested-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html", "inherits": { "type": { "name": "QueryBase", @@ -59062,15 +61599,80 @@ }, "kind": "interface", "name": { - "name": "MatchAllQuery", + "name": "NestedQuery", "namespace": "_types.query_dsl" }, - "properties": [], - "specLocation": "_types/query_dsl/MatchAllQuery.ts#L22-L25" + "properties": [ + { + "description": "Indicates whether to ignore an unmapped path and not return any documents instead of an error.", + "name": "ignore_unmapped", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If defined, each search hit will contain inner hits.", + "docId": "inner-hits", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", + "name": "inner_hits", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InnerHits", + "namespace": "_global.search._types" + } + } + }, + { + "description": "Path to the nested object you wish to search.", + "name": "path", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Query you wish to run on nested objects in the path.", + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "How scores for matching child objects affect the root parent document’s relevance score.", + "name": "score_mode", + "required": false, + "serverDefault": "'avg'", + "type": { + "kind": "instance_of", + "type": { + "name": "ChildScoreMode", + "namespace": "_types.query_dsl" + } + } + } + ], + "specLocation": "_types/query_dsl/joining.ts#L112-L139" }, { - "extDocId": "query-dsl-match-bool-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-bool-prefix-query.html", + "extDocId": "query-dsl-parent-id-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-parent-id-query.html", "inherits": { "type": { "name": "QueryBase", @@ -59079,137 +61681,174 @@ }, "kind": "interface", "name": { - "name": "MatchBoolPrefixQuery", + "name": "ParentIdQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Analyzer used to convert the text in the query value into tokens.", - "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", - "name": "analyzer", + "description": "ID of the parent document.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.", + "name": "ignore_unmapped", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "Maximum edit distance allowed for matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", - "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", - "name": "fuzziness", + "description": "Name of the child relationship mapped for the `join` field.", + "name": "type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fuzziness", + "name": "RelationName", "namespace": "_types" } } + } + ], + "specLocation": "_types/query_dsl/joining.ts#L141-L158" + }, + { + "extDocId": "query-dsl-percolate-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-percolate-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "PercolateQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "The source of the document being percolated.", + "name": "document", + "required": false, + "type": { + "kind": "user_defined_value" + } }, { - "description": "Method used to rewrite the query.\nCan be applied to the term subqueries constructed for all terms but the final term.", - "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", - "name": "fuzzy_rewrite", + "description": "An array of sources of the documents being percolated.", + "name": "documents", "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "user_defined_value" + } + } + }, + { + "description": "Field that holds the indexed queries. The field must use the `percolator` mapping type.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", + "name": "Field", "namespace": "_types" } } }, { - "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.", - "name": "fuzzy_transpositions", + "description": "The ID of a stored document to percolate.", + "name": "id", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "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.", - "name": "max_expansions", + "description": "The index of a stored document to percolate.", + "name": "index", "required": false, - "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "IndexName", "namespace": "_types" } } }, { - "description": "Minimum number of clauses that must match for a document to be returned.\nApplied to the constructed bool query.", - "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", - "name": "minimum_should_match", + "description": "The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified.", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Boolean logic used to interpret text in the query value.\nApplied to the constructed bool query.", - "name": "operator", + "description": "Preference used to fetch document to percolate.", + "name": "preference", "required": false, - "serverDefault": "'or'", "type": { "kind": "instance_of", "type": { - "name": "Operator", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "prefix_length", + "description": "Routing used to fetch document to percolate.", + "name": "routing", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Routing", "namespace": "_types" } } }, { - "description": "Terms you wish to find in the provided field.\nThe last term is used in a prefix query.", - "name": "query", - "required": true, + "description": "The expected version of a stored document to percolate.", + "name": "version", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionNumber", + "namespace": "_types" } } } ], - "shortcutProperty": "query", - "specLocation": "_types/query_dsl/fulltext.ts#L355-L412" + "specLocation": "_types/query_dsl/specialized.ts#L205-L245" }, { - "extDocId": "query-dsl-match-none-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html#query-dsl-match-none-query", + "extDocId": "query-dsl-pinned-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html", "inherits": { "type": { "name": "QueryBase", @@ -59218,15 +61857,96 @@ }, "kind": "interface", "name": { - "name": "MatchNoneQuery", + "name": "PinnedQuery", "namespace": "_types.query_dsl" }, - "properties": [], - "specLocation": "_types/query_dsl/MatchNoneQuery.ts#L22-L25" + "properties": [ + { + "containerProperty": true, + "description": "Any choice of query used to rank documents which will be ranked below the \"pinned\" documents.", + "name": "organic", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Document IDs listed in the order they are to appear in results.\nRequired if `docs` is not specified.", + "name": "ids", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + }, + { + "description": "Documents listed in the order they are to appear in results.\nRequired if `ids` is not specified.", + "name": "docs", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PinnedDoc", + "namespace": "_types.query_dsl" + } + } + } + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L247-L267", + "variants": { + "kind": "container" + } }, { - "extDocId": "query-dsl-match-query-phrase", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html", + "kind": "interface", + "name": { + "name": "PinnedDoc", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "The unique document ID.", + "name": "_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "The index that contains the document.", + "name": "_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L269-L278" + }, + { + "extDocId": "query-dsl-prefix-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", "inherits": { "type": { "name": "QueryBase", @@ -59235,27 +61955,27 @@ }, "kind": "interface", "name": { - "name": "MatchPhraseQuery", + "name": "PrefixQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Analyzer used to convert the text in the query value into tokens.", - "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", - "name": "analyzer", + "description": "Method used to rewrite the query.", + "docId": "query-dsl-multi-term-rewrite", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "name": "rewrite", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "MultiTermQueryRewrite", + "namespace": "_types" } } }, { - "description": "Query terms that are analyzed and turned into a phrase query.", - "name": "query", + "description": "Beginning characters of terms you wish to find in the provided field.", + "name": "value", "required": true, "type": { "kind": "instance_of", @@ -59266,38 +61986,31 @@ } }, { - "description": "Maximum number of positions allowed between matching tokens.", - "name": "slop", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "availability": { + "serverless": {}, + "stack": { + "since": "7.10.0" } - } - }, - { - "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", - "name": "zero_terms_query", + }, + "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.", + "name": "case_insensitive", "required": false, - "serverDefault": "'none'", + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "ZeroTermsQuery", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } } ], - "shortcutProperty": "query", - "specLocation": "_types/query_dsl/fulltext.ts#L414-L438" + "shortcutProperty": "value", + "specLocation": "_types/query_dsl/term.ts#L98-L120" }, { - "extDocId": "query-dsl-match-query-phrase-prefix", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html", + "extDocId": "query-dsl-query-string-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html", "inherits": { "type": { "name": "QueryBase", @@ -59306,126 +62019,105 @@ }, "kind": "interface", "name": { - "name": "MatchPhrasePrefixQuery", + "name": "QueryStringQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Analyzer used to convert text in the query value into tokens.", - "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", - "name": "analyzer", + "description": "If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string.", + "name": "allow_leading_wildcard", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "Maximum number of terms to which the last provided term of the query value will expand.", - "name": "max_expansions", + "description": "Analyzer used to convert text in the query string into tokens.", + "docId": "analysis", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "name": "analyzer", "required": false, - "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Text you wish to find in the provided field.", - "name": "query", - "required": true, + "description": "If `true`, the query attempts to analyze wildcard terms in the query string.", + "name": "analyze_wildcard", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "Maximum number of positions allowed between matching tokens.", - "name": "slop", + "description": "If `true`, match phrase queries are automatically created for multi-term synonyms.", + "name": "auto_generate_synonyms_phrase_query", "required": false, - "serverDefault": 0, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.", - "name": "zero_terms_query", + "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 `*`.", + "name": "default_field", "required": false, - "serverDefault": "none", "type": { "kind": "instance_of", "type": { - "name": "ZeroTermsQuery", - "namespace": "_types.query_dsl" + "name": "Field", + "namespace": "_types" } } - } - ], - "shortcutProperty": "query", - "specLocation": "_types/query_dsl/fulltext.ts#L440-L469" - }, - { - "extDocId": "query-dsl-mlt-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "MoreLikeThisQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.", - "extDocId": "analysis", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", - "name": "analyzer", + "description": "Default boolean logic used to interpret text in the query string if no operators are specified.", + "name": "default_operator", "required": false, + "serverDefault": "'or'", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Operator", + "namespace": "_types.query_dsl" } } }, { - "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).", - "name": "boost_terms", + "description": "If `true`, enable position increments in queries constructed from a `query_string` search.", + "name": "enable_position_increments", "required": false, - "serverDefault": 0, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "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`).", - "name": "fail_on_unsupported_field", + "name": "escape", "required": false, - "serverDefault": true, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -59435,7 +62127,7 @@ } }, { - "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 `*`.", + "description": "Array of fields to search. Supports wildcards (`*`).", "name": "fields", "required": false, "type": { @@ -59450,62 +62142,24 @@ } }, { - "description": "Specifies whether the input documents should also be included in the search results returned.", - "name": "include", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Specifies free form text and/or a single or multiple documents for which you want to find similar documents.", - "name": "like", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Like", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Like", - "namespace": "_types.query_dsl" - } - } - } - ], - "kind": "union_of" - } - }, - { - "description": "The maximum document frequency above which the terms are ignored from the input document.", - "name": "max_doc_freq", + "description": "Maximum edit distance allowed for fuzzy matching.", + "docId": "fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "name": "fuzziness", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Fuzziness", "namespace": "_types" } } }, { - "description": "The maximum number of query terms that can be selected.", - "name": "max_query_terms", + "description": "Maximum number of terms to which the query expands for fuzzy matching.", + "name": "fuzzy_max_expansions", "required": false, - "serverDefault": 25, + "serverDefault": 50, "type": { "kind": "instance_of", "type": { @@ -59515,8 +62169,8 @@ } }, { - "description": "The maximum word length above which the terms are ignored.\nDefaults to unbounded (`0`).", - "name": "max_word_length", + "description": "Number of beginning characters left unchanged for fuzzy matching.", + "name": "fuzzy_prefix_length", "required": false, "serverDefault": 0, "type": { @@ -59528,50 +62182,50 @@ } }, { - "description": "The minimum document frequency below which the terms are ignored from the input document.", - "name": "min_doc_freq", + "description": "Method used to rewrite the query.", + "docId": "query-dsl-multi-term-rewrite", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "name": "fuzzy_rewrite", "required": false, - "serverDefault": 5, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "MultiTermQueryRewrite", "namespace": "_types" } } }, { - "description": "After the disjunctive query has been formed, this parameter controls the number of terms that must match.", - "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", - "name": "minimum_should_match", + "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", + "name": "fuzzy_transpositions", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The minimum term frequency below which the terms are ignored from the input document.", - "name": "min_term_freq", + "description": "If `true`, format-based errors, such as providing a text value for a numeric field, are ignored.", + "name": "lenient", "required": false, - "serverDefault": 2, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The minimum word length below which the terms are ignored.", - "name": "min_word_length", + "description": "Maximum number of automaton states required for the query.", + "name": "max_determinized_states", "required": false, - "serverDefault": 0, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { @@ -59581,565 +62235,514 @@ } }, { - "name": "routing", + "description": "Minimum number of clauses that must match for a document to be returned.", + "docId": "query-dsl-minimum-should-match", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "name": "minimum_should_match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", + "name": "MinimumShouldMatch", "namespace": "_types" } } }, { - "description": "An array of stop words.\nAny word in this set is ignored.", - "name": "stop_words", + "description": "Maximum number of positions allowed between matching tokens for phrases.", + "name": "phrase_slop", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "name": "double", + "namespace": "_types" } } }, { - "description": "Used in combination with `like` to exclude documents that match a set of terms.", - "name": "unlike", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "Like", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Like", - "namespace": "_types.query_dsl" - } - } - } - ], - "kind": "union_of" - } - }, - { - "name": "version", - "required": false, + "description": "Query string you wish to parse and use for search.", + "name": "query", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "version_type", + "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.", + "name": "quote_analyzer", "required": false, - "serverDefault": "'internal'", "type": { - "kind": "instance_of", - "type": { - "name": "VersionType", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/query_dsl/specialized.ts#L87-L172" - }, - { - "codegenNames": [ - "text", - "document" - ], - "description": "Text that we want similar documents for or a lookup to a document's field for the text.", - "docId": "document-input-parameters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", - "kind": "type_alias", - "name": { - "name": "Like", - "namespace": "_types.query_dsl" - }, - "specLocation": "_types/query_dsl/specialized.ts#L198-L203", - "type": { - "items": [ - { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "LikeDocument", - "namespace": "_types.query_dsl" - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "LikeDocument", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "description": "A document not present in the index.", - "name": "doc", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "name": "fields", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } } }, { - "description": "ID of a document.", - "name": "_id", + "description": "Suffix appended to quoted text in the query string.\nYou can use this suffix to use a different analysis method for exact matches.", + "name": "quote_field_suffix", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Index of a document.", - "name": "_index", + "description": "Method used to rewrite the query.", + "docId": "query-dsl-multi-term-rewrite", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "name": "rewrite", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "MultiTermQueryRewrite", "namespace": "_types" } } }, { - "description": "Overrides the default analyzer.", - "name": "per_field_analyzer", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "routing", + "description": "How to combine the queries generated from the individual search terms in the resulting `dis_max` query.", + "name": "tie_breaker", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", + "name": "double", "namespace": "_types" } } }, { - "name": "version", + "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC.", + "name": "time_zone", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "TimeZone", "namespace": "_types" } } }, { - "name": "version_type", + "description": "Determines how the query matches and scores documents.", + "name": "type", "required": false, - "serverDefault": "'internal'", + "serverDefault": "'best_fields'", "type": { "kind": "instance_of", "type": { - "name": "VersionType", - "namespace": "_types" + "name": "TextQueryType", + "namespace": "_types.query_dsl" } } } ], - "specLocation": "_types/query_dsl/specialized.ts#L174-L196" + "specLocation": "_types/query_dsl/fulltext.ts#L598-L721" }, { - "kind": "enum", - "members": [ - { - "description": "Use internal versioning that starts at 1 and increments with each update or delete.", - "name": "internal" - }, - { - "description": "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.", - "name": "external" - }, - { - "description": "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.", - "name": "external_gte" - }, - { - "description": "This option is deprecated because it can cause primary and replica shards to diverge.", - "name": "force" - } - ], + "kind": "type_alias", "name": { - "name": "VersionType", + "name": "TimeZone", "namespace": "_types" }, - "specLocation": "_types/common.ts#L100-L119" + "specLocation": "_types/Time.ts#L47-L47", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "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.", + "codegenNames": [ + "untyped", + "date", + "number", + "term" + ], + "extDocId": "query-dsl-range-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", "kind": "type_alias", "name": { - "name": "StopWords", - "namespace": "_types.analysis" + "name": "RangeQuery", + "namespace": "_types.query_dsl" }, - "specLocation": "_types/analysis/StopWords.ts#L20-L26", + "specLocation": "_types/query_dsl/term.ts#L176-L186", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "UntypedRangeQuery", + "namespace": "_types.query_dsl" } }, { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "DateRangeQuery", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NumberRangeQuery", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TermRangeQuery", + "namespace": "_types.query_dsl" } } ], "kind": "union_of" + }, + "variants": { + "kind": "untagged", + "untypedVariant": { + "name": "UntypedRangeQuery", + "namespace": "_types.query_dsl" + } } }, { - "extDocId": "query-dsl-multi-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html", "inherits": { + "generics": [ + { + "kind": "user_defined_value" + } + ], "type": { - "name": "QueryBase", + "name": "RangeQueryBase", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "MultiMatchQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "description": "Analyzer used to convert the text in the query value into tokens.", - "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", - "name": "analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true`, match phrase queries are automatically created for multi-term synonyms.", - "name": "auto_generate_synonyms_phrase_query", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "deprecation": { - "description": "", - "version": "7.3.0" - }, - "name": "cutoff_frequency", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, + "name": "UntypedRangeQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "description": "The fields to be queried.\nDefaults to the `index.query.default_field` index settings, which in turn defaults to `*`.", - "name": "fields", + "description": "Date format used to convert `date` values in the query.", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "DateFormat", "namespace": "_types" } } }, { - "description": "Maximum edit distance allowed for matching.", - "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", - "name": "fuzziness", + "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.", + "name": "time_zone", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fuzziness", + "name": "TimeZone", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/query_dsl/term.ts#L150-L159" + }, + { + "generics": [ { - "description": "Method used to rewrite the query.", - "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", - "name": "fuzzy_rewrite", + "name": "T", + "namespace": "_types.query_dsl.RangeQueryBase" + } + ], + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "RangeQueryBase", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "Indicates how the range query matches values for `range` fields.", + "name": "relation", "required": false, + "serverDefault": "intersects", "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", - "namespace": "_types" + "name": "RangeRelation", + "namespace": "_types.query_dsl" } } }, { - "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.", - "name": "fuzzy_transpositions", + "description": "Greater than.", + "name": "gt", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "T", + "namespace": "_types.query_dsl.RangeQueryBase" } } }, { - "description": "If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.", - "name": "lenient", + "description": "Greater than or equal to.", + "name": "gte", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "T", + "namespace": "_types.query_dsl.RangeQueryBase" } } }, { - "description": "Maximum number of terms to which the query will expand.", - "name": "max_expansions", + "description": "Less than.", + "name": "lt", "required": false, - "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "T", + "namespace": "_types.query_dsl.RangeQueryBase" } } }, { - "description": "Minimum number of clauses that must match for a document to be returned.", - "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", - "name": "minimum_should_match", + "description": "Less than or equal to.", + "name": "lte", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", - "namespace": "_types" + "name": "T", + "namespace": "_types.query_dsl.RangeQueryBase" } } }, { - "description": "Boolean logic used to interpret text in the query value.", - "name": "operator", + "deprecation": { + "description": "Use gte or gt instead", + "version": "8.16.0" + }, + "name": "from", "required": false, - "serverDefault": "'or'", "type": { - "kind": "instance_of", - "type": { - "name": "Operator", - "namespace": "_types.query_dsl" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "T", + "namespace": "_types.query_dsl.RangeQueryBase" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "Number of beginning characters left unchanged for fuzzy matching.", - "name": "prefix_length", + "deprecation": { + "description": "Use lte or lt instead", + "version": "8.16.0" + }, + "name": "to", "required": false, - "serverDefault": 0, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "T", + "namespace": "_types.query_dsl.RangeQueryBase" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } + } + ], + "specLocation": "_types/query_dsl/term.ts#L122-L148" + }, + { + "kind": "enum", + "members": [ + { + "description": "Matches documents with a range field value entirely within the query’s range.", + "name": "within" }, { - "description": "Text, number, boolean value or date you wish to find in the provided field.", - "name": "query", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "description": "Matches documents with a range field value that entirely contains the query’s range.", + "name": "contains" }, { - "description": "Maximum number of positions allowed between matching tokens.", - "name": "slop", - "required": false, - "serverDefault": 0, - "type": { + "description": "Matches documents with a range field value that intersects the query’s range.", + "name": "intersects" + } + ], + "name": { + "name": "RangeRelation", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/term.ts#L188-L201" + }, + { + "docId": "mapping-date-format", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html", + "kind": "type_alias", + "name": { + "name": "DateFormat", + "namespace": "_types" + }, + "specLocation": "_types/Time.ts#L49-L50", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "integer", + "name": "DateMath", "namespace": "_types" } } - }, + ], + "type": { + "name": "RangeQueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "DateRangeQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "description": "Determines how scores for each per-term blended query and scores across groups are combined.", - "name": "tie_breaker", + "description": "Date format used to convert `date` values in the query.", + "name": "format", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "DateFormat", "namespace": "_types" } } }, { - "description": "How `the` multi_match query is executed internally.", - "name": "type", + "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.", + "name": "time_zone", "required": false, - "serverDefault": "'best_fields'", "type": { "kind": "instance_of", "type": { - "name": "TextQueryType", - "namespace": "_types.query_dsl" + "name": "TimeZone", + "namespace": "_types" } } - }, - { - "description": "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.", - "name": "zero_terms_query", - "required": false, - "serverDefault": "'none'", - "type": { + } + ], + "specLocation": "_types/query_dsl/term.ts#L161-L170" + }, + { + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "ZeroTermsQuery", - "namespace": "_types.query_dsl" + "name": "double", + "namespace": "_types" } } + ], + "type": { + "name": "RangeQueryBase", + "namespace": "_types.query_dsl" } - ], - "specLocation": "_types/query_dsl/fulltext.ts#L471-L557" + }, + "kind": "interface", + "name": { + "name": "NumberRangeQuery", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/term.ts#L172-L172" }, { - "kind": "enum", - "members": [ - { - "description": "Finds documents that match any field, but uses the `_score` from the best field.", - "name": "best_fields" - }, - { - "description": "Finds documents that match any field and combines the `_score` from each field.", - "name": "most_fields" - }, - { - "description": "Treats fields with the same analyzer as though they were one big field.\nLooks for each word in any field.", - "name": "cross_fields" - }, - { - "description": "Runs a `match_phrase` query on each field and uses the `_score` from the best field.", - "name": "phrase" - }, - { - "description": "Runs a `match_phrase_prefix` query on each field and uses the `_score` from the best field.", - "name": "phrase_prefix" - }, - { - "description": "Creates a `match_bool_prefix` query on each field and combines the `_score` from each field.", - "name": "bool_prefix" + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "type": { + "name": "RangeQueryBase", + "namespace": "_types.query_dsl" } - ], + }, + "kind": "interface", "name": { - "name": "TextQueryType", + "name": "TermRangeQuery", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/fulltext.ts#L559-L585" + "properties": [], + "specLocation": "_types/query_dsl/term.ts#L174-L174" }, { - "extDocId": "query-dsl-nested-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html", + "extDocId": "query-dsl-rank-feature-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rank-feature-query.html", "inherits": { "type": { "name": "QueryBase", @@ -60148,205 +62751,232 @@ }, "kind": "interface", "name": { - "name": "NestedQuery", + "name": "RankFeatureQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Indicates whether to ignore an unmapped path and not return any documents instead of an error.", - "name": "ignore_unmapped", - "required": false, - "serverDefault": false, + "description": "`rank_feature` or `rank_features` field used to boost relevance scores.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "description": "If defined, each search hit will contain inner hits.", - "docId": "inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", - "name": "inner_hits", + "description": "Saturation function used to boost relevance scores based on the value of the rank feature `field`.", + "name": "saturation", "required": false, "type": { "kind": "instance_of", "type": { - "name": "InnerHits", - "namespace": "_global.search._types" + "name": "RankFeatureFunctionSaturation", + "namespace": "_types.query_dsl" } } }, { - "description": "Path to the nested object you wish to search.", - "name": "path", - "required": true, + "description": "Logarithmic function used to boost relevance scores based on the value of the rank feature `field`.", + "name": "log", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "RankFeatureFunctionLogarithm", + "namespace": "_types.query_dsl" } } }, { - "description": "Query you wish to run on nested objects in the path.", - "name": "query", - "required": true, + "description": "Linear function used to boost relevance scores based on the value of the rank feature `field`.", + "name": "linear", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", + "name": "RankFeatureFunctionLinear", "namespace": "_types.query_dsl" } } }, { - "description": "How scores for matching child objects affect the root parent document’s relevance score.", - "name": "score_mode", + "description": "Sigmoid function used to boost relevance scores based on the value of the rank feature `field`.", + "name": "sigmoid", "required": false, - "serverDefault": "'avg'", "type": { "kind": "instance_of", "type": { - "name": "ChildScoreMode", + "name": "RankFeatureFunctionSigmoid", "namespace": "_types.query_dsl" } } } ], - "specLocation": "_types/query_dsl/joining.ts#L112-L139" + "specLocation": "_types/query_dsl/specialized.ts#L309-L335" }, { - "extDocId": "query-dsl-parent-id-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-parent-id-query.html", "inherits": { "type": { - "name": "QueryBase", + "name": "RankFeatureFunction", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "ParentIdQuery", + "name": "RankFeatureFunctionSaturation", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "ID of the parent document.", - "name": "id", + "description": "Configurable pivot value so that the result will be less than 0.5.", + "name": "pivot", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "float", "namespace": "_types" } } - }, - { - "description": "Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.", - "name": "ignore_unmapped", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L291-L296" + }, + { + "kind": "interface", + "name": { + "name": "RankFeatureFunction", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/specialized.ts#L280-L280" + }, + { + "inherits": { + "type": { + "name": "RankFeatureFunction", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "RankFeatureFunctionLogarithm", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "description": "Name of the child relationship mapped for the `join` field.", - "name": "type", - "required": false, + "description": "Configurable scaling factor.", + "name": "scaling_factor", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "RelationName", + "name": "float", "namespace": "_types" } } } ], - "specLocation": "_types/query_dsl/joining.ts#L141-L158" + "specLocation": "_types/query_dsl/specialized.ts#L284-L289" }, { - "extDocId": "query-dsl-percolate-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-percolate-query.html", "inherits": { "type": { - "name": "QueryBase", + "name": "RankFeatureFunction", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "PercolateQuery", + "name": "RankFeatureFunctionLinear", + "namespace": "_types.query_dsl" + }, + "properties": [], + "specLocation": "_types/query_dsl/specialized.ts#L282-L282" + }, + { + "inherits": { + "type": { + "name": "RankFeatureFunction", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "RankFeatureFunctionSigmoid", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "The source of the document being percolated.", - "name": "document", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "description": "An array of sources of the documents being percolated.", - "name": "documents", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "user_defined_value" - } - } - }, - { - "description": "Field that holds the indexed queries. The field must use the `percolator` mapping type.", - "name": "field", + "description": "Configurable pivot value so that the result will be less than 0.5.", + "name": "pivot", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "float", "namespace": "_types" } } }, { - "description": "The ID of a stored document to percolate.", - "name": "id", - "required": false, + "description": "Configurable Exponent.", + "name": "exponent", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "float", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L298-L307" + }, + { + "extDocId": "query-dsl-regexp-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "RegexpQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "description": "The index of a stored document to percolate.", - "name": "index", + "availability": { + "serverless": {}, + "stack": { + "since": "7.10.0" + } + }, + "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.", + "name": "case_insensitive", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified.", - "name": "name", + "description": "Enables optional operators for the regular expression.", + "docId": "regexp-syntax", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", + "name": "flags", "required": false, "type": { "kind": "instance_of", @@ -60357,47 +62987,53 @@ } }, { - "description": "Preference used to fetch document to percolate.", - "name": "preference", + "description": "Maximum number of automaton states required for the query.", + "name": "max_determinized_states", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Routing used to fetch document to percolate.", - "name": "routing", + "description": "Method used to rewrite the query.", + "docId": "query-dsl-multi-term-rewrite", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "name": "rewrite", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", + "name": "MultiTermQueryRewrite", "namespace": "_types" } } }, { - "description": "The expected version of a stored document to percolate.", - "name": "version", - "required": false, + "description": "Regular expression for terms you wish to find in the provided field.", + "docId": "regexp-syntax", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/query_dsl/specialized.ts#L205-L245" + "shortcutProperty": "value", + "specLocation": "_types/query_dsl/term.ts#L203-L236" }, { - "extDocId": "query-dsl-pinned-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html", + "extDocId": "query-dsl-rule-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html", "inherits": { "type": { "name": "QueryBase", @@ -60406,13 +63042,11 @@ }, "kind": "interface", "name": { - "name": "PinnedQuery", + "name": "RuleQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "containerProperty": true, - "description": "Any choice of query used to rank documents which will be ranked below the \"pinned\" documents.", "name": "organic", "required": true, "type": { @@ -60424,9 +63058,8 @@ } }, { - "description": "Document IDs listed in the order they are to appear in results.\nRequired if `docs` is not specified.", - "name": "ids", - "required": false, + "name": "ruleset_ids", + "required": true, "type": { "kind": "array_of", "value": { @@ -60439,63 +63072,102 @@ } }, { - "description": "Documents listed in the order they are to appear in results.\nRequired if `ids` is not specified.", - "name": "docs", - "required": false, + "name": "match_criteria", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "PinnedDoc", - "namespace": "_types.query_dsl" - } - } + "kind": "user_defined_value" } } ], - "specLocation": "_types/query_dsl/specialized.ts#L247-L267", - "variants": { - "kind": "container" - } + "specLocation": "_types/query_dsl/specialized.ts#L398-L405" }, { + "extDocId": "query-dsl-script-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, "kind": "interface", "name": { - "name": "PinnedDoc", + "name": "ScriptQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "The unique document ID.", - "name": "_id", + "description": "Contains a script to run as a query.\nThis script must return a boolean value, `true` or `false`.", + "name": "script", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Script", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L337-L346" + }, + { + "extDocId": "query-dsl-script-score-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-score-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "ScriptScoreQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "description": "The index that contains the document.", - "name": "_index", + "description": "Documents with a score lower than this floating point number are excluded from the search results.", + "name": "min_score", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "float", + "namespace": "_types" + } + } + }, + { + "description": "Query used to return documents.", + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "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.", + "name": "script", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", "namespace": "_types" } } } ], - "specLocation": "_types/query_dsl/specialized.ts#L269-L278" + "specLocation": "_types/query_dsl/specialized.ts#L348-L365" }, { - "extDocId": "query-dsl-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "extDocId": "query-dsl-semantic-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-semantic-query.html", "inherits": { "type": { "name": "QueryBase", @@ -60504,27 +63176,25 @@ }, "kind": "interface", "name": { - "name": "PrefixQuery", + "name": "SemanticQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Method used to rewrite the query.", - "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", - "name": "rewrite", - "required": false, + "description": "The field to query, which must be a semantic_text field type", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Beginning characters of terms you wish to find in the provided field.", - "name": "value", + "description": "The query text", + "name": "query", "required": true, "type": { "kind": "instance_of", @@ -60533,33 +63203,44 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/query_dsl/SemanticQuery.ts#L22-L30" + }, + { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ { - "availability": { - "serverless": {}, - "stack": { - "since": "7.10.0" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ShapeFieldQuery", + "namespace": "_types.query_dsl" + } } + ], + "meta": { + "key": "field", + "value": "shape" }, - "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.", - "name": "case_insensitive", - "required": false, - "serverDefault": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "name": "AdditionalProperty", + "namespace": "_spec_utils" } } ], - "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L98-L120" - }, - { - "extDocId": "query-dsl-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html", + "extDocId": "query-dsl-shape-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-shape-query.html", "inherits": { "type": { "name": "QueryBase", @@ -60568,15 +63249,14 @@ }, "kind": "interface", "name": { - "name": "QueryStringQuery", + "name": "ShapeQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string.", - "name": "allow_leading_wildcard", + "description": "When set to `true` the query ignores an unmapped field and will not match any documents.", + "name": "ignore_unmapped", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -60584,7 +63264,71 @@ "namespace": "_builtins" } } + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L367-L381" + }, + { + "kind": "interface", + "name": { + "name": "ShapeFieldQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "Queries using a pre-indexed shape.", + "name": "indexed_shape", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FieldLookup", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Spatial relation between the query shape and the document shape.", + "name": "relation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoShapeRelation", + "namespace": "_types" + } + } }, + { + "description": "Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format.", + "name": "shape", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoShape", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/query_dsl/specialized.ts#L383-L396" + }, + { + "extDocId": "query-dsl-simple-query-string-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "SimpleQueryStringQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { "description": "Analyzer used to convert text in the query string into tokens.", "docId": "analysis", @@ -60613,7 +63357,7 @@ } }, { - "description": "If `true`, match phrase queries are automatically created for multi-term synonyms.", + "description": "If `true`, the parser creates a match_phrase query for each multi-position token.", "name": "auto_generate_synonyms_phrase_query", "required": false, "serverDefault": true, @@ -60626,35 +63370,76 @@ } }, { - "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 `*`.", - "name": "default_field", + "description": "Default boolean logic used to interpret text in the query string if no operators are specified.", + "name": "default_operator", "required": false, + "serverDefault": "'or'", "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "Operator", + "namespace": "_types.query_dsl" } } }, { - "description": "Default boolean logic used to interpret text in the query string if no operators are specified.", - "name": "default_operator", + "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 `*`.", + "name": "fields", "required": false, - "serverDefault": "'or'", + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + } + }, + { + "description": "List of enabled operators for the simple query string syntax.", + "name": "flags", + "required": false, + "serverDefault": "ALL", "type": { "kind": "instance_of", "type": { - "name": "Operator", + "name": "SimpleQueryStringFlags", "namespace": "_types.query_dsl" } } }, { - "description": "If `true`, enable position increments in queries constructed from a `query_string` search.", - "name": "enable_position_increments", + "description": "Maximum number of terms to which the query expands for fuzzy matching.", + "name": "fuzzy_max_expansions", + "required": false, + "serverDefault": 50, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Number of beginning characters left unchanged for fuzzy matching.", + "name": "fuzzy_prefix_length", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", + "name": "fuzzy_transpositions", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -60664,7 +63449,8 @@ } }, { - "name": "escape", + "description": "If `true`, format-based errors, such as providing a text value for a numeric field, are ignored.", + "name": "lenient", "required": false, "serverDefault": false, "type": { @@ -60676,353 +63462,492 @@ } }, { - "description": "Array of fields to search. Supports wildcards (`*`).", - "name": "fields", + "description": "Minimum number of clauses that must match for a document to be returned.", + "docId": "query-dsl-minimum-should-match", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "name": "minimum_should_match", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "MinimumShouldMatch", + "namespace": "_types" } } }, { - "description": "Maximum edit distance allowed for fuzzy matching.", - "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", - "name": "fuzziness", - "required": false, + "description": "Query string in the simple query string syntax you wish to parse and use for search.", + "name": "query", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Fuzziness", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Maximum number of terms to which the query expands for fuzzy matching.", - "name": "fuzzy_max_expansions", + "description": "Suffix appended to quoted text in the query string.", + "name": "quote_field_suffix", "required": false, - "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/query_dsl/fulltext.ts#L786-L854" + }, + { + "description": "Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`", + "docId": "supported-flags", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html#supported-flags", + "kind": "type_alias", + "name": { + "name": "SimpleQueryStringFlags", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/fulltext.ts#L723-L727", + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "SimpleQueryStringFlag", + "namespace": "_types.query_dsl" + } + } + ], + "kind": "instance_of", + "type": { + "name": "PipeSeparatedFlags", + "namespace": "_spec_utils" + } + } + }, + { + "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.", + "generics": [ + { + "name": "T", + "namespace": "_spec_utils.PipeSeparatedFlags" + } + ], + "kind": "type_alias", + "name": { + "name": "PipeSeparatedFlags", + "namespace": "_spec_utils" + }, + "specLocation": "_spec_utils/PipeSeparatedFlags.ts#L20-L27", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "T", + "namespace": "_spec_utils.PipeSeparatedFlags" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "extDocId": "query-dsl-span-containing-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-containing-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "SpanContainingQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "Can be any span query.\nMatching spans from `big` that contain matches from `little` are returned.", + "name": "big", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "SpanQuery", + "namespace": "_types.query_dsl" } } }, { - "description": "Number of beginning characters left unchanged for fuzzy matching.", - "name": "fuzzy_prefix_length", + "description": "Can be any span query.\nMatching spans from `big` that contain matches from `little` are returned.", + "name": "little", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "SpanQuery", + "namespace": "_types.query_dsl" + } + } + } + ], + "specLocation": "_types/query_dsl/span.ts#L25-L39" + }, + { + "kind": "interface", + "name": { + "name": "SpanQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "Accepts a list of span queries, but only returns those spans which also match a second span query.", + "name": "span_containing", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "SpanContainingQuery", + "namespace": "_types.query_dsl" } } }, { - "description": "Method used to rewrite the query.", - "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", - "name": "fuzzy_rewrite", + "description": "Allows queries like `span_near` or `span_or` across different fields.", + "name": "span_field_masking", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", - "namespace": "_types" + "name": "SpanFieldMaskingQuery", + "namespace": "_types.query_dsl" } } }, { - "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", - "name": "fuzzy_transpositions", + "description": "Accepts another span query whose matches must appear within the first N positions of the field.", + "name": "span_first", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "SpanFirstQuery", + "namespace": "_types.query_dsl" } } }, { - "description": "If `true`, format-based errors, such as providing a text value for a numeric field, are ignored.", - "name": "lenient", + "name": "span_gap", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "SpanGapQuery", + "namespace": "_types.query_dsl" } } }, { - "description": "Maximum number of automaton states required for the query.", - "name": "max_determinized_states", + "description": "Wraps a `term`, `range`, `prefix`, `wildcard`, `regexp`, or `fuzzy` query.", + "name": "span_multi", "required": false, - "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "SpanMultiTermQuery", + "namespace": "_types.query_dsl" } } }, { - "description": "Minimum number of clauses that must match for a document to be returned.", - "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", - "name": "minimum_should_match", + "description": "Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.", + "name": "span_near", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", - "namespace": "_types" + "name": "SpanNearQuery", + "namespace": "_types.query_dsl" } } }, { - "description": "Maximum number of positions allowed between matching tokens for phrases.", - "name": "phrase_slop", + "description": "Wraps another span query, and excludes any documents which match that query.", + "name": "span_not", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "SpanNotQuery", + "namespace": "_types.query_dsl" } } }, { - "description": "Query string you wish to parse and use for search.", - "name": "query", - "required": true, + "description": "Combines multiple span queries and returns documents which match any of the specified queries.", + "name": "span_or", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SpanOrQuery", + "namespace": "_types.query_dsl" } } }, { - "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.", - "name": "quote_analyzer", + "description": "The equivalent of the `term` query but for use with other span queries.", + "name": "span_term", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "SpanTermQuery", + "namespace": "_types.query_dsl" + } } } }, { - "description": "Suffix appended to quoted text in the query string.\nYou can use this suffix to use a different analysis method for exact matches.", - "name": "quote_field_suffix", + "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.", + "name": "span_within", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SpanWithinQuery", + "namespace": "_types.query_dsl" } } - }, + } + ], + "specLocation": "_types/query_dsl/span.ts#L159-L201", + "variants": { + "kind": "container", + "nonExhaustive": true + } + }, + { + "extDocId": "query-dsl-span-field-masking-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-field-masking-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "SpanFieldMaskingQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "description": "Method used to rewrite the query.", - "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", - "name": "rewrite", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", + "name": "Field", "namespace": "_types" } } }, { - "description": "How to combine the queries generated from the individual search terms in the resulting `dis_max` query.", - "name": "tie_breaker", - "required": false, + "name": "query", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "SpanQuery", + "namespace": "_types.query_dsl" } } - }, + } + ], + "specLocation": "_types/query_dsl/span.ts#L41-L47" + }, + { + "extDocId": "query-dsl-span-first-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-first-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "SpanFirstQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC.", - "name": "time_zone", - "required": false, + "description": "Controls the maximum end position permitted in a match.", + "name": "end", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TimeZone", + "name": "integer", "namespace": "_types" } } }, { - "description": "Determines how the query matches and scores documents.", - "name": "type", - "required": false, - "serverDefault": "'best_fields'", + "description": "Can be any other span type query.", + "name": "match", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TextQueryType", + "name": "SpanQuery", "namespace": "_types.query_dsl" } } } ], - "specLocation": "_types/query_dsl/fulltext.ts#L598-L721" + "specLocation": "_types/query_dsl/span.ts#L49-L61" }, { + "description": "Can only be used as a clause in a span_near query.", "kind": "type_alias", "name": { - "name": "TimeZone", - "namespace": "_types" + "name": "SpanGapQuery", + "namespace": "_types.query_dsl" }, - "specLocation": "_types/Time.ts#L47-L47", + "specLocation": "_types/query_dsl/span.ts#L63-L65", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } }, { - "codegenNames": [ - "untyped", - "date", - "number", - "term" - ], - "extDocId": "query-dsl-range-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", - "kind": "type_alias", + "extDocId": "query-dsl-span-multi-term-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-multi-term-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", "name": { - "name": "RangeQuery", + "name": "SpanMultiTermQuery", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/term.ts#L176-L186", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "UntypedRangeQuery", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DateRangeQuery", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "instance_of", - "type": { - "name": "NumberRangeQuery", - "namespace": "_types.query_dsl" - } - }, - { + "properties": [ + { + "description": "Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query).", + "name": "match", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "TermRangeQuery", + "name": "QueryContainer", "namespace": "_types.query_dsl" } } - ], - "kind": "union_of" - }, - "variants": { - "kind": "untagged", - "untypedVariant": { - "name": "UntypedRangeQuery", - "namespace": "_types.query_dsl" } - } + ], + "specLocation": "_types/query_dsl/span.ts#L67-L75" }, { + "extDocId": "query-dsl-span-near-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-near-query.html", "inherits": { - "generics": [ - { - "kind": "user_defined_value" - } - ], "type": { - "name": "RangeQueryBase", + "name": "QueryBase", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "UntypedRangeQuery", + "name": "SpanNearQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Date format used to convert `date` values in the query.", - "name": "format", + "description": "Array of one or more other span type queries.", + "name": "clauses", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SpanQuery", + "namespace": "_types.query_dsl" + } + } + } + }, + { + "description": "Controls whether matches are required to be in-order.", + "name": "in_order", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateFormat", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.", - "name": "time_zone", + "description": "Controls the maximum number of intervening unmatched positions permitted.", + "name": "slop", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TimeZone", + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "_types/query_dsl/term.ts#L150-L159" + "specLocation": "_types/query_dsl/span.ts#L77-L93" }, { - "generics": [ - { - "name": "T", - "namespace": "_types.query_dsl.RangeQueryBase" - } - ], + "extDocId": "query-dsl-span-not-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-not-query.html", "inherits": { "type": { "name": "QueryBase", @@ -61031,267 +63956,242 @@ }, "kind": "interface", "name": { - "name": "RangeQueryBase", + "name": "SpanNotQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Indicates how the range query matches values for `range` fields.", - "name": "relation", + "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`.", + "name": "dist", "required": false, - "serverDefault": "intersects", "type": { "kind": "instance_of", "type": { - "name": "RangeRelation", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Greater than.", - "name": "gt", - "required": false, + "description": "Span query whose matches must not overlap those returned.", + "name": "exclude", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "T", - "namespace": "_types.query_dsl.RangeQueryBase" + "name": "SpanQuery", + "namespace": "_types.query_dsl" } } }, { - "description": "Greater than or equal to.", - "name": "gte", - "required": false, + "description": "Span query whose matches are filtered.", + "name": "include", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "T", - "namespace": "_types.query_dsl.RangeQueryBase" + "name": "SpanQuery", + "namespace": "_types.query_dsl" } } }, { - "description": "Less than.", - "name": "lt", + "description": "The number of tokens after the include span that can’t have overlap with the exclude span.", + "name": "post", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "T", - "namespace": "_types.query_dsl.RangeQueryBase" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Less than or equal to.", - "name": "lte", + "description": "The number of tokens before the include span that can’t have overlap with the exclude span.", + "name": "pre", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "T", - "namespace": "_types.query_dsl.RangeQueryBase" + "name": "integer", + "namespace": "_types" } } - }, - { - "deprecation": { - "description": "Use gte or gt instead", - "version": "8.16.0" - }, - "name": "from", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "T", - "namespace": "_types.query_dsl.RangeQueryBase" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "deprecation": { - "description": "Use lte or lt instead", - "version": "8.16.0" - }, - "name": "to", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "T", - "namespace": "_types.query_dsl.RangeQueryBase" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - } - ], - "specLocation": "_types/query_dsl/term.ts#L122-L148" - }, - { - "kind": "enum", - "members": [ - { - "description": "Matches documents with a range field value entirely within the query’s range.", - "name": "within" - }, - { - "description": "Matches documents with a range field value that entirely contains the query’s range.", - "name": "contains" - }, - { - "description": "Matches documents with a range field value that intersects the query’s range.", - "name": "intersects" } ], - "name": { - "name": "RangeRelation", - "namespace": "_types.query_dsl" - }, - "specLocation": "_types/query_dsl/term.ts#L188-L201" - }, - { - "docId": "mapping-date-format", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html", - "kind": "type_alias", - "name": { - "name": "DateFormat", - "namespace": "_types" - }, - "specLocation": "_types/Time.ts#L49-L50", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "specLocation": "_types/query_dsl/span.ts#L95-L122" }, { + "extDocId": "query-dsl-span-or-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-or-query.html", "inherits": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "DateMath", - "namespace": "_types" - } - } - ], "type": { - "name": "RangeQueryBase", + "name": "QueryBase", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "DateRangeQuery", + "name": "SpanOrQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Date format used to convert `date` values in the query.", - "name": "format", - "required": false, + "description": "Array of one or more other span type queries.", + "name": "clauses", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "DateFormat", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SpanQuery", + "namespace": "_types.query_dsl" + } } } - }, + } + ], + "specLocation": "_types/query_dsl/span.ts#L124-L132" + }, + { + "extDocId": "query-dsl-span-term-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "SpanTermQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ { - "description": "Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.", - "name": "time_zone", - "required": false, + "aliases": [ + "term" + ], + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TimeZone", + "name": "FieldValue", "namespace": "_types" } } } ], - "specLocation": "_types/query_dsl/term.ts#L161-L170" + "shortcutProperty": "value", + "specLocation": "_types/query_dsl/span.ts#L134-L141" }, { - "inherits": { - "generics": [ + "codegenNames": [ + "long", + "double", + "string", + "boolean", + "null" + ], + "description": "A field value.", + "kind": "type_alias", + "name": { + "name": "FieldValue", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L25-L31", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + }, { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } - } - ], - "type": { - "name": "RangeQueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "NumberRangeQuery", - "namespace": "_types.query_dsl" - }, - "properties": [], - "specLocation": "_types/query_dsl/term.ts#L172-L172" - }, - { - "inherits": { - "generics": [ + }, { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } + }, + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } } ], + "kind": "union_of" + } + }, + { + "extDocId": "query-dsl-span-within-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-within-query.html", + "inherits": { "type": { - "name": "RangeQueryBase", + "name": "QueryBase", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "TermRangeQuery", + "name": "SpanWithinQuery", "namespace": "_types.query_dsl" }, - "properties": [], - "specLocation": "_types/query_dsl/term.ts#L174-L174" + "properties": [ + { + "description": "Can be any span query.\nMatching spans from `little` that are enclosed within `big` are returned.", + "name": "big", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "SpanQuery", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Can be any span query.\nMatching spans from `little` that are enclosed within `big` are returned.", + "name": "little", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "SpanQuery", + "namespace": "_types.query_dsl" + } + } + } + ], + "specLocation": "_types/query_dsl/span.ts#L143-L157" }, { - "extDocId": "query-dsl-rank-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rank-feature-query.html", + "extDocId": "query-dsl-sparse-vector-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-sparse-vector-query.html", "inherits": { "type": { "name": "QueryBase", @@ -61300,12 +64200,13 @@ }, "kind": "interface", "name": { - "name": "RankFeatureQuery", + "name": "SparseVectorQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "`rank_feature` or `rank_features` field used to boost relevance scores.", + "containerProperty": true, + "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.", "name": "field", "required": true, "type": { @@ -61317,73 +64218,128 @@ } }, { - "description": "Saturation function used to boost relevance scores based on the value of the rank feature `field`.", - "name": "saturation", + "description": "Dictionary of precomputed sparse vectors and their associated weights.\nOnly one of inference_id or query_vector may be supplied in a request.", + "name": "query_vector", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } + } + }, + { + "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.", + "name": "inference_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RankFeatureFunctionSaturation", - "namespace": "_types.query_dsl" + "name": "Id", + "namespace": "_types" } } }, { - "description": "Logarithmic function used to boost relevance scores based on the value of the rank feature `field`.", - "name": "log", + "containerProperty": true, + "description": "The query text you want to use for search.\nIf inference_id is specified, query must also be specified.", + "name": "query", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RankFeatureFunctionLogarithm", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Linear function used to boost relevance scores based on the value of the rank feature `field`.", - "name": "linear", + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "since": "8.15.0", + "stability": "experimental" + } + }, + "containerProperty": true, + "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", + "name": "prune", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RankFeatureFunctionLinear", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Sigmoid function used to boost relevance scores based on the value of the rank feature `field`.", - "name": "sigmoid", + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "since": "8.15.0", + "stability": "experimental" + } + }, + "containerProperty": true, + "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.", + "name": "pruning_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RankFeatureFunctionSigmoid", + "name": "TokenPruningConfig", "namespace": "_types.query_dsl" } } } ], - "specLocation": "_types/query_dsl/specialized.ts#L309-L335" + "specLocation": "_types/query_dsl/SparseVectorQuery.ts#L26-L80", + "variants": { + "kind": "container" + } }, { - "inherits": { - "type": { - "name": "RankFeatureFunction", - "namespace": "_types.query_dsl" - } - }, "kind": "interface", "name": { - "name": "RankFeatureFunctionSaturation", + "name": "TokenPruningConfig", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Configurable pivot value so that the result will be less than 0.5.", - "name": "pivot", + "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.", + "name": "tokens_freq_ratio_threshold", + "required": false, + "serverDefault": 5, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Tokens whose weight is less than this threshold are considered nonsignificant and pruned.", + "name": "tokens_weight_threshold", "required": false, + "serverDefault": 0.4, "type": { "kind": "instance_of", "type": { @@ -61391,105 +64347,212 @@ "namespace": "_types" } } + }, + { + "description": "Whether to only score pruned tokens, vs only scoring kept tokens.", + "name": "only_score_pruned_tokens", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "_types/query_dsl/specialized.ts#L291-L296" - }, - { - "kind": "interface", - "name": { - "name": "RankFeatureFunction", - "namespace": "_types.query_dsl" - }, - "properties": [], - "specLocation": "_types/query_dsl/specialized.ts#L280-L280" + "specLocation": "_types/query_dsl/TokenPruningConfig.ts#L22-L35" }, { + "extDocId": "query-dsl-term-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", "inherits": { "type": { - "name": "RankFeatureFunction", + "name": "QueryBase", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "RankFeatureFunctionLogarithm", + "name": "TermQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Configurable scaling factor.", - "name": "scaling_factor", + "description": "Term you wish to find in the provided field.", + "name": "value", "required": true, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "FieldValue", "namespace": "_types" } } + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "7.10.0" + } + }, + "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.", + "name": "case_insensitive", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "_types/query_dsl/specialized.ts#L284-L289" + "shortcutProperty": "value", + "specLocation": "_types/query_dsl/term.ts#L238-L255" }, { + "attachedBehaviors": [ + "AdditionalProperty" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TermsQueryField", + "namespace": "_types.query_dsl" + } + } + ], + "meta": { + "key": "field", + "value": "terms" + }, + "type": { + "name": "AdditionalProperty", + "namespace": "_spec_utils" + } + } + ], + "extDocId": "query-dsl-terms-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", "inherits": { "type": { - "name": "RankFeatureFunction", + "name": "QueryBase", "namespace": "_types.query_dsl" } }, "kind": "interface", "name": { - "name": "RankFeatureFunctionLinear", + "name": "TermsQuery", "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/specialized.ts#L282-L282" + "specLocation": "_types/query_dsl/term.ts#L257-L263" }, { - "inherits": { - "type": { - "name": "RankFeatureFunction", - "namespace": "_types.query_dsl" - } + "codegenNames": [ + "value", + "lookup" + ], + "kind": "type_alias", + "name": { + "name": "TermsQueryField", + "namespace": "_types.query_dsl" }, + "specLocation": "_types/query_dsl/term.ts#L265-L268", + "type": { + "items": [ + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } + }, + { + "kind": "instance_of", + "type": { + "name": "TermsLookup", + "namespace": "_types.query_dsl" + } + } + ], + "kind": "union_of" + } + }, + { "kind": "interface", "name": { - "name": "RankFeatureFunctionSigmoid", + "name": "TermsLookup", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Configurable pivot value so that the result will be less than 0.5.", - "name": "pivot", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "IndexName", "namespace": "_types" } } }, { - "description": "Configurable Exponent.", - "name": "exponent", + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "Id", + "namespace": "_types" + } + } + }, + { + "name": "path", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", "namespace": "_types" } } } ], - "specLocation": "_types/query_dsl/specialized.ts#L298-L307" + "specLocation": "_types/query_dsl/term.ts#L270-L275" }, { - "extDocId": "query-dsl-regexp-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html", + "extDocId": "query-dsl-terms-set-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-set-query.html", "inherits": { "type": { "name": "QueryBase", @@ -61498,7 +64561,7 @@ }, "kind": "interface", "name": { - "name": "RegexpQuery", + "name": "TermsSetQuery", "namespace": "_types.query_dsl" }, "properties": [ @@ -61506,83 +64569,128 @@ "availability": { "serverless": {}, "stack": { - "since": "7.10.0" + "since": "8.10.0" } }, - "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.", - "name": "case_insensitive", + "description": "Specification describing number of matching terms required to return a document.", + "name": "minimum_should_match", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "MinimumShouldMatch", + "namespace": "_types" } } }, { - "description": "Enables optional operators for the regular expression.", - "docId": "regexp-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", - "name": "flags", + "description": "Numeric field containing the number of matching terms required to return a document.", + "name": "minimum_should_match_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "description": "Maximum number of automaton states required for the query.", - "name": "max_determinized_states", + "description": "Custom script containing the number of matching terms required to return a document.", + "name": "minimum_should_match_script", "required": false, - "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Script", "namespace": "_types" } } }, { - "description": "Method used to rewrite the query.", - "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", - "name": "rewrite", - "required": false, + "description": "Array of terms you wish to find in the provided field.", + "name": "terms", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } + } + } + ], + "specLocation": "_types/query_dsl/term.ts#L277-L299" + }, + { + "extDocId": "query-dsl-text-expansion-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-text-expansion-query.html", + "inherits": { + "type": { + "name": "QueryBase", + "namespace": "_types.query_dsl" + } + }, + "kind": "interface", + "name": { + "name": "TextExpansionQuery", + "namespace": "_types.query_dsl" + }, + "properties": [ + { + "description": "The text expansion NLP model to use", + "name": "model_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Regular expression for terms you wish to find in the provided field.", - "docId": "regexp-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", - "name": "value", + "description": "The query text", + "name": "model_text", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "since": "8.13.0", + "stability": "experimental" + } + }, + "description": "Token pruning configurations", + "name": "pruning_config", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TokenPruningConfig", + "namespace": "_types.query_dsl" } } } ], - "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L203-L236" + "specLocation": "_types/query_dsl/TextExpansionQuery.ts#L23-L36" }, { - "extDocId": "query-dsl-rule-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html", + "extDocId": "query-dsl-weighted-tokens-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-weighted-tokens-query.html", "inherits": { "type": { "name": "QueryBase", @@ -61591,48 +64699,51 @@ }, "kind": "interface", "name": { - "name": "RuleQuery", + "name": "WeightedTokensQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "name": "organic", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "ruleset_ids", + "description": "The tokens representing this query", + "name": "tokens", "required": true, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "Id", + "name": "float", "namespace": "_types" } } } }, { - "name": "match_criteria", - "required": true, + "description": "Token pruning configurations", + "name": "pruning_config", + "required": false, "type": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "TokenPruningConfig", + "namespace": "_types.query_dsl" + } } } ], - "specLocation": "_types/query_dsl/specialized.ts#L398-L405" + "specLocation": "_types/query_dsl/WeightedTokensQuery.ts#L25-L33" }, { - "extDocId": "query-dsl-script-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-query.html", + "extDocId": "query-dsl-wildcard-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", "inherits": { "type": { "name": "QueryBase", @@ -61641,82 +64752,73 @@ }, "kind": "interface", "name": { - "name": "ScriptQuery", + "name": "WildcardQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "Contains a script to run as a query.\nThis script must return a boolean value, `true` or `false`.", - "name": "script", - "required": true, + "availability": { + "serverless": {}, + "stack": { + "since": "7.10.0" + } + }, + "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.", + "name": "case_insensitive", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/query_dsl/specialized.ts#L337-L346" - }, - { - "extDocId": "query-dsl-script-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-score-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "ScriptScoreQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "description": "Documents with a score lower than this floating point number are excluded from the search results.", - "name": "min_score", + "description": "Method used to rewrite the query.", + "docId": "query-dsl-multi-term-rewrite", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "name": "rewrite", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "MultiTermQueryRewrite", "namespace": "_types" } } }, { - "description": "Query used to return documents.", - "name": "query", - "required": true, + "description": "Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set.", + "name": "value", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "script", - "required": true, + "description": "Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set.", + "name": "wildcard", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/query_dsl/specialized.ts#L348-L365" + "shortcutProperty": "value", + "specLocation": "_types/query_dsl/term.ts#L305-L325" }, { - "extDocId": "query-dsl-semantic-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-semantic-query.html", + "extDocId": "query-dsl-wrapper-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wrapper-query.html", "inherits": { "type": { "name": "QueryBase", @@ -61725,24 +64827,12 @@ }, "kind": "interface", "name": { - "name": "SemanticQuery", + "name": "WrapperQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "The field to query, which must be a semantic_text field type", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The query text", + "description": "A base64 encoded query.\nThe binary data format can be any of JSON, YAML, CBOR or SMILE encodings", "name": "query", "required": true, "type": { @@ -61754,42 +64844,9 @@ } } ], - "specLocation": "_types/query_dsl/SemanticQuery.ts#L22-L30" + "specLocation": "_types/query_dsl/abstractions.ts#L508-L517" }, { - "attachedBehaviors": [ - "AdditionalProperty" - ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ShapeFieldQuery", - "namespace": "_types.query_dsl" - } - } - ], - "meta": { - "key": "field", - "value": "shape" - }, - "type": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" - } - } - ], - "extDocId": "query-dsl-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-shape-query.html", "inherits": { "type": { "name": "QueryBase", @@ -61798,91 +64855,67 @@ }, "kind": "interface", "name": { - "name": "ShapeQuery", + "name": "TypeQuery", "namespace": "_types.query_dsl" }, "properties": [ { - "description": "When set to `true` the query ignores an unmapped field and will not match any documents.", - "name": "ignore_unmapped", - "required": false, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "_types/query_dsl/specialized.ts#L367-L381" + "specLocation": "_types/query_dsl/term.ts#L301-L303" }, { + "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", + "inherits": { + "type": { + "name": "BucketAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "ShapeFieldQuery", - "namespace": "_types.query_dsl" + "name": "AutoDateHistogramAggregation", + "namespace": "_types.aggregations" }, "properties": [ { - "description": "Queries using a pre-indexed shape.", - "name": "indexed_shape", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FieldLookup", - "namespace": "_types.query_dsl" - } - } - }, - { - "description": "Spatial relation between the query shape and the document shape.", - "name": "relation", + "description": "The target number of buckets.", + "name": "buckets", "required": false, + "serverDefault": 10, "type": { "kind": "instance_of", "type": { - "name": "GeoShapeRelation", + "name": "integer", "namespace": "_types" } } }, { - "description": "Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format.", - "name": "shape", + "description": "The field on which to run the aggregation.", + "name": "field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoShape", + "name": "Field", "namespace": "_types" } } - } - ], - "specLocation": "_types/query_dsl/specialized.ts#L383-L396" - }, - { - "extDocId": "query-dsl-simple-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "SimpleQueryStringQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "description": "Analyzer used to convert text in the query string into tokens.", - "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", - "name": "analyzer", + "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.", + "name": "format", "required": false, "type": { "kind": "instance_of", @@ -61893,141 +64926,292 @@ } }, { - "description": "If `true`, the query attempts to analyze wildcard terms in the query string.", - "name": "analyze_wildcard", + "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`.", + "name": "minimum_interval", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "MinimumInterval", + "namespace": "_types.aggregations" } } }, { - "description": "If `true`, the parser creates a match_phrase query for each multi-position token.", - "name": "auto_generate_synonyms_phrase_query", + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "name": "missing", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "description": "Default boolean logic used to interpret text in the query string if no operators are specified.", - "name": "default_operator", + "description": "Time zone specified as a ISO 8601 UTC offset.", + "name": "offset", "required": false, - "serverDefault": "'or'", "type": { "kind": "instance_of", "type": { - "name": "Operator", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } }, { - "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 `*`.", - "name": "fields", + "name": "params", "required": false, "type": { - "kind": "array_of", - "value": { + "key": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "description": "List of enabled operators for the simple query string syntax.", - "name": "flags", + "name": "script", "required": false, - "serverDefault": "ALL", "type": { "kind": "instance_of", "type": { - "name": "SimpleQueryStringFlags", - "namespace": "_types.query_dsl" + "name": "Script", + "namespace": "_types" } } }, { - "description": "Maximum number of terms to which the query expands for fuzzy matching.", - "name": "fuzzy_max_expansions", + "description": "Time zone ID.", + "name": "time_zone", "required": false, - "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "TimeZone", "namespace": "_types" } } + } + ], + "specLocation": "_types/aggregations/bucket.ts#L72-L110" + }, + { + "kind": "enum", + "members": [ + { + "name": "second" }, { - "description": "Number of beginning characters left unchanged for fuzzy matching.", - "name": "fuzzy_prefix_length", - "required": false, - "serverDefault": 0, - "type": { + "name": "minute" + }, + { + "name": "hour" + }, + { + "name": "day" + }, + { + "name": "month" + }, + { + "name": "year" + } + ], + "name": { + "name": "MinimumInterval", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/bucket.ts#L112-L119" + }, + { + "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.", + "kind": "type_alias", + "name": { + "name": "DateTime", + "namespace": "_types" + }, + "specLocation": "_types/Time.ts#L22-L27", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "integer", + "name": "string", + "namespace": "_builtins" + } + }, + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", "namespace": "_types" } } - }, + ], + "kind": "union_of" + } + }, + { + "generics": [ { - "description": "If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).", - "name": "fuzzy_transpositions", + "name": "Unit", + "namespace": "_types.EpochTime" + } + ], + "kind": "type_alias", + "name": { + "name": "EpochTime", + "namespace": "_types" + }, + "specLocation": "_types/Time.ts#L40-L40", + "type": { + "kind": "instance_of", + "type": { + "name": "Unit", + "namespace": "_types.EpochTime" + } + } + }, + { + "inherits": { + "type": { + "name": "FormatMetricAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "AverageAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/metric.ts#L55-L55" + }, + { + "inherits": { + "type": { + "name": "MetricAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "FormatMetricAggregationBase", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } + } + ], + "specLocation": "_types/aggregations/metric.ts#L47-L49" + }, + { + "kind": "interface", + "name": { + "name": "MetricAggregationBase", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "description": "The field on which to run the aggregation.", + "name": "field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } }, { - "description": "If `true`, format-based errors, such as providing a text value for a numeric field, are ignored.", - "name": "lenient", + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "name": "missing", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Missing", + "namespace": "_types.aggregations" } } }, { - "description": "Minimum number of clauses that must match for a document to be returned.", - "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", - "name": "minimum_should_match", + "name": "script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", + "name": "Script", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/aggregations/metric.ts#L34-L45" + }, + { + "extDocId": "search-aggregations-pipeline-avg-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-avg-bucket-aggregation.html", + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "AverageBucketAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L78-L81" + }, + { + "inherits": { + "type": { + "name": "BucketPathAggregation", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + }, + "properties": [ { - "description": "Query string in the simple query string syntax you wish to parse and use for search.", - "name": "query", - "required": true, + "description": "`DecimalFormat` pattern for the output value.\nIf specified, the formatted value is returned in the aggregation’s `value_as_string` property.", + "name": "format", + "required": false, "type": { "kind": "instance_of", "type": { @@ -62037,75 +65221,101 @@ } }, { - "description": "Suffix appended to quoted text in the query string.", - "name": "quote_field_suffix", + "description": "Policy to apply when gaps are found in the data.", + "docId": "gap-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#gap-policy", + "name": "gap_policy", "required": false, + "serverDefault": "skip", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "GapPolicy", + "namespace": "_types.aggregations" } } } ], - "specLocation": "_types/query_dsl/fulltext.ts#L786-L854" + "specLocation": "_types/aggregations/pipeline.ts#L39-L51" }, { - "description": "Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`", - "docId": "supported-flags", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html#supported-flags", - "kind": "type_alias", + "inherits": { + "type": { + "name": "Aggregation", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", "name": { - "name": "SimpleQueryStringFlags", - "namespace": "_types.query_dsl" + "name": "BucketPathAggregation", + "namespace": "_types.aggregations" }, - "specLocation": "_types/query_dsl/fulltext.ts#L723-L727", - "type": { - "generics": [ - { + "properties": [ + { + "description": "Path to the buckets that contain one set of values to correlate.", + "docId": "search-aggregations-pipeline-bucket-path", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#buckets-path-syntax", + "name": "buckets_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SimpleQueryStringFlag", - "namespace": "_types.query_dsl" + "name": "BucketsPath", + "namespace": "_types.aggregations" } } - ], - "kind": "instance_of", - "type": { - "name": "PipeSeparatedFlags", - "namespace": "_spec_utils" } - } + ], + "specLocation": "_types/aggregations/pipeline.ts#L31-L37" }, { - "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.", - "generics": [ - { - "name": "T", - "namespace": "_spec_utils.PipeSeparatedFlags" - } + "codegenNames": [ + "single", + "array", + "dict" ], + "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.", "kind": "type_alias", "name": { - "name": "PipeSeparatedFlags", - "namespace": "_spec_utils" + "name": "BucketsPath", + "namespace": "_types.aggregations" }, - "specLocation": "_spec_utils/PipeSeparatedFlags.ts#L20-L27", + "specLocation": "_types/aggregations/pipeline.ts#L53-L59", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "T", - "namespace": "_spec_utils.PipeSeparatedFlags" + "name": "string", + "namespace": "_builtins" } }, { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } ], @@ -62113,376 +65323,502 @@ } }, { - "extDocId": "query-dsl-span-containing-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-containing-query.html", + "kind": "enum", + "members": [ + { + "description": "Treats missing data as if the bucket does not exist. It will skip the bucket and\ncontinue calculating using the next available value.", + "name": "skip" + }, + { + "description": "Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal.", + "name": "insert_zeros" + }, + { + "description": "Similar to skip, except if the metric provides a non-null, non-NaN value this value is used,\notherwise the empty bucket is skipped.", + "name": "keep_values" + } + ], + "name": { + "name": "GapPolicy", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/pipeline.ts#L61-L76" + }, + { "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "MetricAggregationBase", + "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "SpanContainingQuery", - "namespace": "_types.query_dsl" + "name": "BoxplotAggregation", + "namespace": "_types.aggregations" }, "properties": [ { - "description": "Can be any span query.\nMatching spans from `big` that contain matches from `little` are returned.", - "name": "big", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" - } - } - }, - { - "description": "Can be any span query.\nMatching spans from `big` that contain matches from `little` are returned.", - "name": "little", - "required": true, + "description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.", + "name": "compression", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" + "name": "double", + "namespace": "_types" } } } ], - "specLocation": "_types/query_dsl/span.ts#L25-L39" + "specLocation": "_types/aggregations/metric.ts#L57-L62" }, { + "extDocId": "search-aggregations-pipeline-bucket-script-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html", + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" + "name": "BucketScriptAggregation", + "namespace": "_types.aggregations" }, "properties": [ { - "description": "Accepts a list of span queries, but only returns those spans which also match a second span query.", - "name": "span_containing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SpanContainingQuery", - "namespace": "_types.query_dsl" - } - } - }, - { - "description": "Allows queries like `span_near` or `span_or` across different fields.", - "name": "span_field_masking", + "description": "The script to run for this aggregation.", + "name": "script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanFieldMaskingQuery", - "namespace": "_types.query_dsl" + "name": "Script", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L83-L91" + }, + { + "extDocId": "search-aggregations-pipeline-bucket-selector-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html", + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "BucketSelectorAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ { - "description": "Accepts another span query whose matches must appear within the first N positions of the field.", - "name": "span_first", + "description": "The script to run for this aggregation.", + "name": "script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanFirstQuery", - "namespace": "_types.query_dsl" + "name": "Script", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L93-L101" + }, + { + "extDocId": "search-aggregations-pipeline-bucket-sort-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-sort-aggregation.html", + "inherits": { + "type": { + "name": "Aggregation", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "BucketSortAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ { - "name": "span_gap", + "description": "Buckets in positions prior to `from` will be truncated.", + "name": "from", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanGapQuery", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Wraps a `term`, `range`, `prefix`, `wildcard`, `regexp`, or `fuzzy` query.", - "name": "span_multi", + "description": "The policy to apply when gaps are found in the data.", + "docId": "gap-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#gap-policy", + "name": "gap_policy", "required": false, + "serverDefault": "skip", "type": { "kind": "instance_of", "type": { - "name": "SpanMultiTermQuery", - "namespace": "_types.query_dsl" + "name": "GapPolicy", + "namespace": "_types.aggregations" } } }, { - "description": "Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.", - "name": "span_near", + "description": "The number of buckets to return.\nDefaults to all buckets of the parent aggregation.", + "name": "size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanNearQuery", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Wraps another span query, and excludes any documents which match that query.", - "name": "span_not", + "description": "The list of fields to sort on.", + "docId": "sort-search-results", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "name": "sort", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanNotQuery", - "namespace": "_types.query_dsl" + "name": "Sort", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L180-L204" + }, + { + "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.", + "extDocId": "search-aggregations-bucket-count-ks-test-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-count-ks-test-aggregation.html", + "inherits": { + "type": { + "name": "BucketPathAggregation", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "BucketKsAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ { - "description": "Combines multiple span queries and returns documents which match any of the specified queries.", - "name": "span_or", + "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.", + "name": "alternative", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "SpanOrQuery", - "namespace": "_types.query_dsl" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "The equivalent of the `term` query but for use with other span queries.", - "name": "span_term", + "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.", + "name": "fractions", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "SpanTermQuery", - "namespace": "_types.query_dsl" + "name": "double", + "namespace": "_types" } } } }, { - "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.", - "name": "span_within", + "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`.", + "name": "sampling_method", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanWithinQuery", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/query_dsl/span.ts#L159-L201", - "variants": { - "kind": "container", - "nonExhaustive": true - } + "specLocation": "_types/aggregations/pipeline.ts#L103-L137" }, { - "extDocId": "query-dsl-span-field-masking-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-field-masking-query.html", + "description": "A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.", + "extDocId": "search-aggregations-bucket-correlation-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-correlation-aggregation.html", "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "BucketPathAggregation", + "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "SpanFieldMaskingQuery", - "namespace": "_types.query_dsl" + "name": "BucketCorrelationAggregation", + "namespace": "_types.aggregations" }, "properties": [ { - "name": "field", + "description": "The correlation function to execute.", + "name": "function", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "BucketCorrelationFunction", + "namespace": "_types.aggregations" } } - }, + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L139-L146" + }, + { + "kind": "interface", + "name": { + "name": "BucketCorrelationFunction", + "namespace": "_types.aggregations" + }, + "properties": [ { - "name": "query", + "description": "The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric.", + "name": "count_correlation", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" + "name": "BucketCorrelationFunctionCountCorrelation", + "namespace": "_types.aggregations" } } } ], - "specLocation": "_types/query_dsl/span.ts#L41-L47" + "specLocation": "_types/aggregations/pipeline.ts#L148-L153" }, { - "extDocId": "query-dsl-span-first-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-first-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, "kind": "interface", "name": { - "name": "SpanFirstQuery", - "namespace": "_types.query_dsl" + "name": "BucketCorrelationFunctionCountCorrelation", + "namespace": "_types.aggregations" }, "properties": [ { - "description": "Controls the maximum end position permitted in a match.", - "name": "end", + "description": "The indicator with which to correlate the configured `bucket_path` values.", + "name": "indicator", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "BucketCorrelationFunctionCountCorrelationIndicator", + "namespace": "_types.aggregations" } } - }, + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L155-L158" + }, + { + "kind": "interface", + "name": { + "name": "BucketCorrelationFunctionCountCorrelationIndicator", + "namespace": "_types.aggregations" + }, + "properties": [ { - "description": "Can be any other span type query.", - "name": "match", + "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.", + "name": "doc_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "_types/query_dsl/span.ts#L49-L61" - }, - { - "description": "Can only be used as a clause in a span_near query.", - "kind": "type_alias", - "name": { - "name": "SpanGapQuery", - "namespace": "_types.query_dsl" - }, - "specLocation": "_types/query_dsl/span.ts#L63-L65", - "type": { - "key": { - "kind": "instance_of", + }, + { + "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`.", + "name": "expectations", + "required": true, "type": { - "name": "Field", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } } }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", + { + "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.", + "name": "fractions", + "required": false, "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } } } - } + ], + "specLocation": "_types/aggregations/pipeline.ts#L160-L178" }, { - "extDocId": "query-dsl-span-multi-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-multi-term-query.html", "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "MetricAggregationBase", + "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "SpanMultiTermQuery", - "namespace": "_types.query_dsl" + "name": "CardinalityAggregation", + "namespace": "_types.aggregations" }, "properties": [ { - "description": "Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query).", - "name": "match", - "required": true, + "description": "A unique count below which counts are expected to be close to accurate.\nThis allows to trade memory for accuracy.", + "name": "precision_threshold", + "required": false, + "serverDefault": 3000, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "rehash", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Mechanism by which cardinality aggregations is run.", + "name": "execution_hint", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "CardinalityExecutionMode", + "namespace": "_types.aggregations" } } } ], - "specLocation": "_types/query_dsl/span.ts#L67-L75" + "specLocation": "_types/aggregations/metric.ts#L87-L99" }, { - "extDocId": "query-dsl-span-near-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-near-query.html", + "kind": "enum", + "members": [ + { + "description": "Run the aggregation by using global ordinals of the field and resolving those values after finishing a shard.", + "name": "global_ordinals" + }, + { + "description": "Run the aggregation by using segment ordinal values and resolving those values after each segment.", + "name": "segment_ordinals" + }, + { + "description": "Run the aggregation by using field values directly.", + "name": "direct" + }, + { + "description": "Heuristic-based mode, default in Elasticsearch 8.3 and earlier.", + "name": "save_memory_heuristic" + }, + { + "description": "Heuristic-based mode, default in Elasticsearch 8.4 and later.", + "name": "save_time_heuristic" + } + ], + "name": { + "name": "CardinalityExecutionMode", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/metric.ts#L64-L85" + }, + { + "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.", + "extDocId": "search-aggregations-bucket-categorize-text-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-categorize-text-aggregation.html", "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "Aggregation", + "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "SpanNearQuery", - "namespace": "_types.query_dsl" + "name": "CategorizeTextAggregation", + "namespace": "_types.aggregations" }, "properties": [ { - "description": "Array of one or more other span type queries.", - "name": "clauses", + "description": "The semi-structured text field to categorize.", + "name": "field", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" } } }, { - "description": "Controls whether matches are required to be in-order.", - "name": "in_order", + "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.", + "name": "max_unique_tokens", "required": false, + "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Controls the maximum number of intervening unmatched positions permitted.", - "name": "slop", + "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.", + "name": "max_matched_tokens", "required": false, + "serverDefault": 5, "type": { "kind": "instance_of", "type": { @@ -62490,29 +65826,12 @@ "namespace": "_types" } } - } - ], - "specLocation": "_types/query_dsl/span.ts#L77-L93" - }, - { - "extDocId": "query-dsl-span-not-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-not-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "SpanNotQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "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`.", - "name": "dist", + "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.", + "name": "similarity_threshold", "required": false, + "serverDefault": 50, "type": { "kind": "instance_of", "type": { @@ -62522,34 +65841,36 @@ } }, { - "description": "Span query whose matches must not overlap those returned.", - "name": "exclude", - "required": true, + "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.", + "name": "categorization_filters", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "Span query whose matches are filtered.", - "name": "include", - "required": true, + "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 endpoint](https://www.elastic.co/guide/en/elasticsearch/reference/8.0/indices-analyze.html). This property\ncannot be used at the same time as categorization_filters.", + "name": "categorization_analyzer", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" + "name": "CategorizeTextAnalyzer", + "namespace": "_types.aggregations" } } }, { - "description": "The number of tokens after the include span that can’t have overlap with the exclude span.", - "name": "post", + "description": "The number of categorization buckets to return from each shard before merging all the results.", + "name": "shard_size", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -62559,10 +65880,10 @@ } }, { - "description": "The number of tokens before the include span that can’t have overlap with the exclude span.", - "name": "pre", + "description": "The number of buckets to return.", + "name": "size", "required": false, - "serverDefault": 0, + "serverDefault": 10, "type": { "kind": "instance_of", "type": { @@ -62570,107 +65891,47 @@ "namespace": "_types" } } - } - ], - "specLocation": "_types/query_dsl/span.ts#L95-L122" - }, - { - "extDocId": "query-dsl-span-or-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-or-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "SpanOrQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "description": "Array of one or more other span type queries.", - "name": "clauses", - "required": true, + "description": "The minimum number of documents in a bucket to be returned to the results.", + "name": "min_doc_count", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "_types/query_dsl/span.ts#L124-L132" - }, - { - "extDocId": "query-dsl-span-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "SpanTermQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ + }, { - "aliases": [ - "term" - ], - "name": "value", - "required": true, + "description": "The minimum number of documents in a bucket to be returned from the shard before merging.", + "name": "shard_min_doc_count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldValue", + "name": "integer", "namespace": "_types" } } } ], - "shortcutProperty": "value", - "specLocation": "_types/query_dsl/span.ts#L134-L141" + "specLocation": "_types/aggregations/bucket.ts#L1117-L1182" }, { "codegenNames": [ - "long", - "double", - "string", - "boolean", - "null" + "builtin", + "custom" ], - "description": "A field value.", "kind": "type_alias", "name": { - "name": "FieldValue", - "namespace": "_types" + "name": "CategorizeTextAnalyzer", + "namespace": "_types.aggregations" }, - "specLocation": "_types/common.ts#L25-L31", + "specLocation": "_types/aggregations/bucket.ts#L1184-L1187", "type": { "items": [ - { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, { "kind": "instance_of", "type": { @@ -62681,15 +65942,8 @@ { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" + "name": "CustomCategorizeTextAnalyzer", + "namespace": "_types.aggregations" } } ], @@ -62697,114 +65951,28 @@ } }, { - "extDocId": "query-dsl-span-within-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-within-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "SpanWithinQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "description": "Can be any span query.\nMatching spans from `little` that are enclosed within `big` are returned.", - "name": "big", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" - } - } - }, - { - "description": "Can be any span query.\nMatching spans from `little` that are enclosed within `big` are returned.", - "name": "little", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SpanQuery", - "namespace": "_types.query_dsl" - } - } - } - ], - "specLocation": "_types/query_dsl/span.ts#L143-L157" - }, - { - "extDocId": "query-dsl-sparse-vector-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-sparse-vector-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, "kind": "interface", "name": { - "name": "SparseVectorQuery", - "namespace": "_types.query_dsl" + "name": "CustomCategorizeTextAnalyzer", + "namespace": "_types.aggregations" }, "properties": [ { - "containerProperty": true, - "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.", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "Dictionary of precomputed sparse vectors and their associated weights.\nOnly one of inference_id or query_vector may be supplied in a request.", - "name": "query_vector", + "name": "char_filter", "required": false, "type": { - "key": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } - } - }, - { - "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.", - "name": "inference_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" } } }, { - "containerProperty": true, - "description": "The query text you want to use for search.\nIf inference_id is specified, query must also be specified.", - "name": "query", + "name": "tokenizer", "required": false, "type": { "kind": "instance_of", @@ -62815,616 +65983,575 @@ } }, { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "since": "8.15.0", - "stability": "experimental" - } - }, - "containerProperty": true, - "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", - "name": "prune", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "since": "8.15.0", - "stability": "experimental" - } - }, - "containerProperty": true, - "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.", - "name": "pruning_config", + "name": "filter", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "TokenPruningConfig", - "namespace": "_types.query_dsl" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } ], - "specLocation": "_types/query_dsl/SparseVectorQuery.ts#L26-L80", - "variants": { - "kind": "container" - } + "specLocation": "_types/aggregations/bucket.ts#L1189-L1193" }, { + "inherits": { + "type": { + "name": "BucketAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "TokenPruningConfig", - "namespace": "_types.query_dsl" + "name": "ChildrenAggregation", + "namespace": "_types.aggregations" }, "properties": [ { - "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.", - "name": "tokens_freq_ratio_threshold", - "required": false, - "serverDefault": 5, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Tokens whose weight is less than this threshold are considered nonsignificant and pruned.", - "name": "tokens_weight_threshold", + "description": "The child type that should be selected.", + "name": "type", "required": false, - "serverDefault": 0.4, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "RelationName", "namespace": "_types" } } - }, - { - "description": "Whether to only score pruned tokens, vs only scoring kept tokens.", - "name": "only_score_pruned_tokens", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } } ], - "specLocation": "_types/query_dsl/TokenPruningConfig.ts#L22-L35" + "specLocation": "_types/aggregations/bucket.ts#L121-L126" }, { - "extDocId": "query-dsl-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "extDocId": "search-aggregations-bucket-composite-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-composite-aggregation.html", "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "BucketAggregationBase", + "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "TermQuery", - "namespace": "_types.query_dsl" + "name": "CompositeAggregation", + "namespace": "_types.aggregations" }, "properties": [ { - "description": "Term you wish to find in the provided field.", - "name": "value", - "required": true, + "description": "When paginating, use the `after_key` value returned in the previous response to retrieve the next page.", + "name": "after", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldValue", - "namespace": "_types" + "name": "CompositeAggregateKey", + "namespace": "_types.aggregations" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.10.0" - } - }, - "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.", - "name": "case_insensitive", + "description": "The number of composite buckets that should be returned.", + "name": "size", "required": false, - "serverDefault": false, + "serverDefault": 10, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - } - ], - "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L238-L255" - }, - { - "attachedBehaviors": [ - "AdditionalProperty" - ], - "behaviors": [ + }, { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TermsQueryField", - "namespace": "_types.query_dsl" + "description": "The value sources used to build composite buckets.\nKeys are returned in the order of the `sources` definition.", + "name": "sources", + "required": false, + "type": { + "kind": "array_of", + "value": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "CompositeAggregationSource", + "namespace": "_types.aggregations" + } } } - ], - "meta": { - "key": "field", - "value": "terms" - }, - "type": { - "name": "AdditionalProperty", - "namespace": "_spec_utils" } } ], - "extDocId": "query-dsl-terms-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "TermsQuery", - "namespace": "_types.query_dsl" - }, - "properties": [], - "specLocation": "_types/query_dsl/term.ts#L257-L263" + "specLocation": "_types/aggregations/bucket.ts#L130-L149" }, { - "codegenNames": [ - "value", - "lookup" - ], "kind": "type_alias", "name": { - "name": "TermsQueryField", - "namespace": "_types.query_dsl" + "name": "CompositeAggregateKey", + "namespace": "_types.aggregations" }, - "specLocation": "_types/query_dsl/term.ts#L265-L268", + "specLocation": "_types/aggregations/bucket.ts#L128-L128", "type": { - "items": [ - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldValue", - "namespace": "_types" - } - } - }, - { - "kind": "instance_of", - "type": { - "name": "TermsLookup", - "namespace": "_types.query_dsl" - } + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" } - ], - "kind": "union_of" + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } } }, { "kind": "interface", "name": { - "name": "TermsLookup", - "namespace": "_types.query_dsl" + "name": "CompositeAggregationSource", + "namespace": "_types.aggregations" }, "properties": [ { - "name": "index", - "required": true, + "description": "A terms aggregation.", + "name": "terms", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "CompositeTermsAggregation", + "namespace": "_types.aggregations" } } }, { - "name": "id", - "required": true, + "description": "A histogram aggregation.", + "name": "histogram", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "CompositeHistogramAggregation", + "namespace": "_types.aggregations" } } }, { - "name": "path", - "required": true, + "description": "A date histogram aggregation.", + "name": "date_histogram", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "CompositeDateHistogramAggregation", + "namespace": "_types.aggregations" } } }, { - "name": "routing", + "description": "A geotile grid aggregation.", + "name": "geotile_grid", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "CompositeGeoTileGridAggregation", + "namespace": "_types.aggregations" } } } ], - "specLocation": "_types/query_dsl/term.ts#L270-L275" + "specLocation": "_types/aggregations/bucket.ts#L151-L168" }, { - "extDocId": "query-dsl-terms-set-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-set-query.html", "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "CompositeAggregationBase", + "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "TermsSetQuery", - "namespace": "_types.query_dsl" + "name": "CompositeTermsAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/bucket.ts#L181-L181" + }, + { + "kind": "interface", + "name": { + "name": "CompositeAggregationBase", + "namespace": "_types.aggregations" }, "properties": [ { - "availability": { - "serverless": {}, - "stack": { - "since": "8.10.0" - } - }, - "description": "Specification describing number of matching terms required to return a document.", - "name": "minimum_should_match", + "description": "Either `field` or `script` must be present", + "name": "field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumShouldMatch", + "name": "Field", "namespace": "_types" } } }, { - "description": "Numeric field containing the number of matching terms required to return a document.", - "name": "minimum_should_match_field", + "name": "missing_bucket", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Custom script containing the number of matching terms required to return a document.", - "name": "minimum_should_match_script", + "name": "missing_order", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "MissingOrder", + "namespace": "_types.aggregations" } } }, { - "description": "Array of terms you wish to find in the provided field.", - "name": "terms", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldValue", - "namespace": "_types" - } - } - } - } - ], - "specLocation": "_types/query_dsl/term.ts#L277-L299" - }, - { - "extDocId": "query-dsl-text-expansion-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-text-expansion-query.html", - "inherits": { - "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" - } - }, - "kind": "interface", - "name": { - "name": "TextExpansionQuery", - "namespace": "_types.query_dsl" - }, - "properties": [ - { - "description": "The text expansion NLP model to use", - "name": "model_id", - "required": true, + "description": "Either `field` or `script` must be present", + "name": "script", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Script", + "namespace": "_types" } } }, { - "description": "The query text", - "name": "model_text", - "required": true, + "name": "value_type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ValueType", + "namespace": "_types.aggregations" } } }, { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "since": "8.13.0", - "stability": "experimental" - } - }, - "description": "Token pruning configurations", - "name": "pruning_config", + "name": "order", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TokenPruningConfig", - "namespace": "_types.query_dsl" + "name": "SortOrder", + "namespace": "_types" } } } ], - "specLocation": "_types/query_dsl/TextExpansionQuery.ts#L23-L36" + "specLocation": "_types/aggregations/bucket.ts#L170-L179" + }, + { + "kind": "enum", + "members": [ + { + "name": "first" + }, + { + "name": "last" + }, + { + "name": "default" + } + ], + "name": { + "name": "MissingOrder", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/AggregationContainer.ts#L536-L540" + }, + { + "kind": "enum", + "members": [ + { + "name": "string" + }, + { + "name": "long" + }, + { + "name": "double" + }, + { + "name": "number" + }, + { + "name": "date" + }, + { + "name": "date_nanos" + }, + { + "name": "ip" + }, + { + "name": "numeric" + }, + { + "name": "geo_point" + }, + { + "name": "boolean" + } + ], + "name": { + "name": "ValueType", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/metric.ts#L436-L447" }, { - "extDocId": "query-dsl-weighted-tokens-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-weighted-tokens-query.html", "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "CompositeAggregationBase", + "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "WeightedTokensQuery", - "namespace": "_types.query_dsl" + "name": "CompositeHistogramAggregation", + "namespace": "_types.aggregations" }, "properties": [ { - "description": "The tokens representing this query", - "name": "tokens", + "name": "interval", "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } - } - }, - { - "description": "Token pruning configurations", - "name": "pruning_config", - "required": false, "type": { "kind": "instance_of", "type": { - "name": "TokenPruningConfig", - "namespace": "_types.query_dsl" + "name": "double", + "namespace": "_types" } } } ], - "specLocation": "_types/query_dsl/WeightedTokensQuery.ts#L25-L33" + "specLocation": "_types/aggregations/bucket.ts#L183-L185" }, { - "extDocId": "query-dsl-wildcard-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "CompositeAggregationBase", + "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "WildcardQuery", - "namespace": "_types.query_dsl" + "name": "CompositeDateHistogramAggregation", + "namespace": "_types.aggregations" }, "properties": [ { - "availability": { - "serverless": {}, - "stack": { - "since": "7.10.0" - } - }, - "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.", - "name": "case_insensitive", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "Method used to rewrite the query.", - "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", - "name": "rewrite", + "description": "Either `calendar_interval` or `fixed_interval` must be present", + "name": "calendar_interval", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MultiTermQueryRewrite", + "name": "DurationLarge", "namespace": "_types" } } }, { - "description": "Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set.", - "name": "value", + "description": "Either `calendar_interval` or `fixed_interval` must be present", + "name": "fixed_interval", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DurationLarge", + "namespace": "_types" } } }, { - "description": "Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set.", - "name": "wildcard", + "name": "offset", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "name": "time_zone", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeZone", + "namespace": "_types" } } } ], - "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L305-L325" + "specLocation": "_types/aggregations/bucket.ts#L187-L195" }, { - "extDocId": "query-dsl-wrapper-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wrapper-query.html", - "inherits": { + "description": "A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and\n`y` (year)", + "kind": "type_alias", + "name": { + "name": "DurationLarge", + "namespace": "_types" + }, + "specLocation": "_types/Time.ts#L60-L65", + "type": { + "kind": "instance_of", "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "string", + "namespace": "_builtins" } - }, - "kind": "interface", + } + }, + { + "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.", + "docId": "time-value", + "docUrl": "https://github.com/elastic/elasticsearch/blob/current/libs/core/src/main/java/org/elasticsearch/core/TimeValue.java", + "kind": "type_alias", "name": { - "name": "WrapperQuery", - "namespace": "_types.query_dsl" + "name": "Duration", + "namespace": "_types" }, - "properties": [ - { - "description": "A base64 encoded query.\nThe binary data format can be any of JSON, YAML, CBOR or SMILE encodings", - "name": "query", - "required": true, - "type": { + "specLocation": "_types/Time.ts#L52-L58", + "type": { + "items": [ + { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } + }, + { + "kind": "literal_value", + "value": -1 + }, + { + "kind": "literal_value", + "value": 0 } - } - ], - "specLocation": "_types/query_dsl/abstractions.ts#L508-L517" + ], + "kind": "union_of" + } }, { "inherits": { "type": { - "name": "QueryBase", - "namespace": "_types.query_dsl" + "name": "CompositeAggregationBase", + "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "TypeQuery", - "namespace": "_types.query_dsl" + "name": "CompositeGeoTileGridAggregation", + "namespace": "_types.aggregations" }, "properties": [ { - "name": "value", - "required": true, + "name": "precision", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "bounds", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoBounds", + "namespace": "_types" } } } ], - "specLocation": "_types/query_dsl/term.ts#L301-L303" + "specLocation": "_types/aggregations/bucket.ts#L197-L200" + }, + { + "extDocId": "search-aggregations-pipeline-cumulative-cardinality-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "CumulativeCardinalityAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L206-L209" + }, + { + "extDocId": "search-aggregations-pipeline-cumulative-sum-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-sum-aggregation.html", + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "CumulativeSumAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L211-L214" }, { - "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -63433,25 +66560,66 @@ }, "kind": "interface", "name": { - "name": "AutoDateHistogramAggregation", + "name": "DateHistogramAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The target number of buckets.", - "name": "buckets", + "description": "Calendar-aware interval.\nCan be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`.", + "name": "calendar_interval", "required": false, - "serverDefault": 10, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "CalendarInterval", + "namespace": "_types.aggregations" } } }, { - "description": "The field on which to run the aggregation.", + "description": "Enables extending the bounds of the histogram beyond the data itself.", + "name": "extended_bounds", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "FieldDateMath", + "namespace": "_types.aggregations" + } + } + ], + "kind": "instance_of", + "type": { + "name": "ExtendedBounds", + "namespace": "_types.aggregations" + } + } + }, + { + "description": "Limits the histogram to specified bounds.", + "name": "hard_bounds", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "FieldDateMath", + "namespace": "_types.aggregations" + } + } + ], + "kind": "instance_of", + "type": { + "name": "ExtendedBounds", + "namespace": "_types.aggregations" + } + } + }, + { + "description": "The date field whose values are use to build a histogram.", "name": "field", "required": false, "type": { @@ -63462,6 +66630,18 @@ } } }, + { + "description": "Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.", + "name": "fixed_interval", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, { "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.", "name": "format", @@ -63475,14 +66655,29 @@ } }, { - "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`.", - "name": "minimum_interval", + "deprecation": { + "description": "use `fixed_interval` or `calendar_interval`", + "version": "7.2.0" + }, + "name": "interval", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MinimumInterval", - "namespace": "_types.aggregations" + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "min_doc_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, @@ -63499,14 +66694,26 @@ } }, { - "description": "Time zone specified as a ISO 8601 UTC offset.", + "description": "Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration.", "name": "offset", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "The sort order of the returned buckets.", + "name": "order", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AggregateOrder", + "namespace": "_types.aggregations" } } }, @@ -63540,7 +66747,7 @@ } }, { - "description": "Time zone ID.", + "description": "Time zone used for bucketing and rounding.\nDefaults to Coordinated Universal Time (UTC).", "name": "time_zone", "required": false, "type": { @@ -63550,154 +66757,206 @@ "namespace": "_types" } } + }, + { + "description": "Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.", + "name": "keyed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "_types/aggregations/bucket.ts#L72-L110" + "specLocation": "_types/aggregations/bucket.ts#L202-L260" }, { "kind": "enum", "members": [ { + "aliases": [ + "1s" + ], "name": "second" }, { + "aliases": [ + "1m" + ], "name": "minute" }, { + "aliases": [ + "1h" + ], "name": "hour" }, { + "aliases": [ + "1d" + ], "name": "day" }, { + "aliases": [ + "1w" + ], + "name": "week" + }, + { + "aliases": [ + "1M" + ], "name": "month" }, { + "aliases": [ + "1q" + ], + "name": "quarter" + }, + { + "aliases": [ + "1y" + ], "name": "year" } ], "name": { - "name": "MinimumInterval", + "name": "CalendarInterval", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L112-L119" + "specLocation": "_types/aggregations/bucket.ts#L262-L279" + }, + { + "generics": [ + { + "name": "T", + "namespace": "_types.aggregations.ExtendedBounds" + } + ], + "kind": "interface", + "name": { + "name": "ExtendedBounds", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "description": "Maximum value for the bound.", + "name": "max", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "T", + "namespace": "_types.aggregations.ExtendedBounds" + } + } + }, + { + "description": "Minimum value for the bound.", + "name": "min", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "T", + "namespace": "_types.aggregations.ExtendedBounds" + } + } + } + ], + "specLocation": "_types/aggregations/bucket.ts#L508-L517" }, { - "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.", "kind": "type_alias", "name": { - "name": "DateTime", - "namespace": "_types" + "name": "AggregateOrder", + "namespace": "_types.aggregations" }, - "specLocation": "_types/Time.ts#L22-L27", + "specLocation": "_types/aggregations/bucket.ts#L1052-L1054", "type": { "items": [ { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "SortOrder", + "namespace": "_types" + } } }, { - "generics": [ - { + "kind": "array_of", + "value": { + "key": { "kind": "instance_of", "type": { - "name": "UnitMillis", + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "SortOrder", "namespace": "_types" } } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" } } ], "kind": "union_of" } }, - { - "generics": [ - { - "name": "Unit", - "namespace": "_types.EpochTime" - } - ], - "kind": "type_alias", - "name": { - "name": "EpochTime", - "namespace": "_types" - }, - "specLocation": "_types/Time.ts#L40-L40", - "type": { - "kind": "instance_of", - "type": { - "name": "Unit", - "namespace": "_types.EpochTime" - } - } - }, { "inherits": { "type": { - "name": "FormatMetricAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "AverageAggregation", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/metric.ts#L55-L55" - }, - { - "inherits": { - "type": { - "name": "MetricAggregationBase", + "name": "BucketAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "FormatMetricAggregationBase", + "name": "DateRangeAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "name": "format", + "description": "The date field whose values are use to build ranges.", + "name": "field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/metric.ts#L47-L49" - }, - { - "kind": "interface", - "name": { - "name": "MetricAggregationBase", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "The field on which to run the aggregation.", - "name": "field", + "description": "The date format used to format `from` and `to` in the response.", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, @@ -63714,216 +66973,141 @@ } }, { - "name": "script", + "description": "Array of date ranges.", + "name": "ranges", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DateRangeExpression", + "namespace": "_types.aggregations" + } + } + } + }, + { + "description": "Time zone used to convert dates from another time zone to UTC.", + "name": "time_zone", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "TimeZone", "namespace": "_types" } } + }, + { + "description": "Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.", + "name": "keyed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "_types/aggregations/metric.ts#L34-L45" - }, - { - "extDocId": "search-aggregations-pipeline-avg-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-avg-bucket-aggregation.html", - "inherits": { - "type": { - "name": "PipelineAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "AverageBucketAggregation", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L78-L81" + "specLocation": "_types/aggregations/bucket.ts#L281-L307" }, { - "inherits": { - "type": { - "name": "BucketPathAggregation", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "PipelineAggregationBase", + "name": "DateRangeExpression", "namespace": "_types.aggregations" }, "properties": [ { - "description": "`DecimalFormat` pattern for the output value.\nIf specified, the formatted value is returned in the aggregation’s `value_as_string` property.", - "name": "format", + "description": "Start of the range (inclusive).", + "name": "from", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "FieldDateMath", + "namespace": "_types.aggregations" } } }, { - "description": "Policy to apply when gaps are found in the data.", - "docId": "gap-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#gap-policy", - "name": "gap_policy", + "description": "Custom key to return the range with.", + "name": "key", "required": false, - "serverDefault": "skip", "type": { "kind": "instance_of", "type": { - "name": "GapPolicy", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L39-L51" - }, - { - "inherits": { - "type": { - "name": "Aggregation", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "BucketPathAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "Path to the buckets that contain one set of values to correlate.", - "docId": "search-aggregations-pipeline-bucket-path", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#buckets-path-syntax", - "name": "buckets_path", + "description": "End of the range (exclusive).", + "name": "to", "required": false, "type": { "kind": "instance_of", "type": { - "name": "BucketsPath", + "name": "FieldDateMath", "namespace": "_types.aggregations" } } } ], - "specLocation": "_types/aggregations/pipeline.ts#L31-L37" + "specLocation": "_types/aggregations/bucket.ts#L318-L331" }, { "codegenNames": [ - "single", - "array", - "dict" + "expr", + "value" ], - "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.", + "description": "A date range limit, represented either as a DateMath expression or a number expressed\naccording to the target field's precision.", "kind": "type_alias", "name": { - "name": "BucketsPath", + "name": "FieldDateMath", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/pipeline.ts#L53-L59", + "specLocation": "_types/aggregations/bucket.ts#L309-L316", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "DateMath", + "namespace": "_types" } - } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ - { - "description": "Treats missing data as if the bucket does not exist. It will skip the bucket and\ncontinue calculating using the next available value.", - "name": "skip" - }, - { - "description": "Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal.", - "name": "insert_zeros" - }, - { - "description": "Similar to skip, except if the metric provides a non-null, non-NaN value this value is used,\notherwise the empty bucket is skipped.", - "name": "keep_values" - } - ], - "name": { - "name": "GapPolicy", - "namespace": "_types.aggregations" - }, - "specLocation": "_types/aggregations/pipeline.ts#L61-L76" - }, - { - "inherits": { - "type": { - "name": "MetricAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "BoxplotAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ - { - "description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.", - "name": "compression", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } } + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "DateMath", + "namespace": "_types" + }, + "specLocation": "_types/Time.ts#L42-L42", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ], - "specLocation": "_types/aggregations/metric.ts#L57-L62" + } }, { - "extDocId": "search-aggregations-pipeline-bucket-script-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -63932,74 +67116,45 @@ }, "kind": "interface", "name": { - "name": "BucketScriptAggregation", + "name": "DerivativeAggregation", "namespace": "_types.aggregations" }, - "properties": [ - { - "description": "The script to run for this aggregation.", - "name": "script", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L83-L91" + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L216-L216" }, { - "extDocId": "search-aggregations-pipeline-bucket-selector-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html", + "extDocId": "search-aggregations-bucket-diversified-sampler-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-diversified-sampler-aggregation.html", "inherits": { "type": { - "name": "PipelineAggregationBase", + "name": "BucketAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "BucketSelectorAggregation", + "name": "DiversifiedSamplerAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The script to run for this aggregation.", - "name": "script", + "description": "The type of value used for de-duplication.", + "name": "execution_hint", "required": false, + "serverDefault": "global_ordinals", "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "SamplerAggregationExecutionHint", + "namespace": "_types.aggregations" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L93-L101" - }, - { - "extDocId": "search-aggregations-pipeline-bucket-sort-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-sort-aggregation.html", - "inherits": { - "type": { - "name": "Aggregation", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "BucketSortAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "Buckets in positions prior to `from` will be truncated.", - "name": "from", + "description": "Limits how many documents are permitted per choice of de-duplicating value.", + "name": "max_docs_per_value", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -64009,24 +67164,21 @@ } }, { - "description": "The policy to apply when gaps are found in the data.", - "docId": "gap-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#gap-policy", - "name": "gap_policy", + "name": "script", "required": false, - "serverDefault": "skip", "type": { "kind": "instance_of", "type": { - "name": "GapPolicy", - "namespace": "_types.aggregations" + "name": "Script", + "namespace": "_types" } } }, { - "description": "The number of buckets to return.\nDefaults to all buckets of the parent aggregation.", - "name": "size", + "description": "Limits how many top-scoring documents are collected in the sample processed on each shard.", + "name": "shard_size", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { @@ -64036,310 +67188,184 @@ } }, { - "description": "The list of fields to sort on.", - "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", - "name": "sort", + "description": "The field used to provide values used for de-duplication.", + "name": "field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Sort", + "name": "Field", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/pipeline.ts#L180-L204" + "specLocation": "_types/aggregations/bucket.ts#L333-L357" }, { - "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.", - "extDocId": "search-aggregations-bucket-count-ks-test-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-count-ks-test-aggregation.html", - "inherits": { - "type": { - "name": "BucketPathAggregation", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "BucketKsAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + "kind": "enum", + "members": [ { - "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.", - "name": "alternative", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } + "description": "Hold field values directly.", + "name": "map" }, { - "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.", - "name": "fractions", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - } + "description": "Hold ordinals of the field as determined by the Lucene index.", + "name": "global_ordinals" }, { - "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`.", - "name": "sampling_method", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "description": "Hold hashes of the field values - with potential for hash collisions.", + "name": "bytes_hash" } ], - "specLocation": "_types/aggregations/pipeline.ts#L103-L137" + "name": { + "name": "SamplerAggregationExecutionHint", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/bucket.ts#L359-L372" }, { - "description": "A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.", - "extDocId": "search-aggregations-bucket-correlation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-correlation-aggregation.html", "inherits": { "type": { - "name": "BucketPathAggregation", + "name": "FormatMetricAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "BucketCorrelationAggregation", + "name": "ExtendedStatsAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The correlation function to execute.", - "name": "function", - "required": true, + "description": "The number of standard deviations above/below the mean to display.", + "name": "sigma", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "BucketCorrelationFunction", - "namespace": "_types.aggregations" + "name": "double", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/pipeline.ts#L139-L146" + "specLocation": "_types/aggregations/metric.ts#L101-L106" }, { - "kind": "interface", - "name": { - "name": "BucketCorrelationFunction", - "namespace": "_types.aggregations" - }, - "properties": [ - { - "description": "The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric.", - "name": "count_correlation", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "BucketCorrelationFunctionCountCorrelation", - "namespace": "_types.aggregations" - } - } + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" } - ], - "specLocation": "_types/aggregations/pipeline.ts#L148-L153" - }, - { + }, "kind": "interface", "name": { - "name": "BucketCorrelationFunctionCountCorrelation", + "name": "ExtendedStatsBucketAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The indicator with which to correlate the configured `bucket_path` values.", - "name": "indicator", - "required": true, + "description": "The number of standard deviations above/below the mean to display.", + "name": "sigma", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "BucketCorrelationFunctionCountCorrelationIndicator", - "namespace": "_types.aggregations" + "name": "double", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/pipeline.ts#L155-L158" + "specLocation": "_types/aggregations/pipeline.ts#L218-L223" }, { + "extDocId": "search-aggregations-bucket-frequent-item-sets-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-frequent-item-sets-aggregation.html", "kind": "interface", "name": { - "name": "BucketCorrelationFunctionCountCorrelationIndicator", + "name": "FrequentItemSetsAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "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.", - "name": "doc_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "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`.", - "name": "expectations", + "description": "Fields to analyze.", + "name": "fields", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "FrequentItemSetsField", + "namespace": "_types.aggregations" } } } }, { - "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.", - "name": "fractions", + "description": "The minimum size of one item set.", + "name": "minimum_set_size", "required": false, + "serverDefault": 1, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L160-L178" - }, - { - "inherits": { - "type": { - "name": "MetricAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "CardinalityAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "A unique count below which counts are expected to be close to accurate.\nThis allows to trade memory for accuracy.", - "name": "precision_threshold", + "description": "The minimum support of one item set.", + "name": "minimum_support", "required": false, - "serverDefault": 3000, + "serverDefault": 0.1, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "name": "rehash", + "description": "The number of top item sets to return.", + "name": "size", "required": false, + "serverDefault": 10, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Mechanism by which cardinality aggregations is run.", - "name": "execution_hint", + "description": "Query that filters documents from analysis.", + "name": "filter", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CardinalityExecutionMode", - "namespace": "_types.aggregations" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } } ], - "specLocation": "_types/aggregations/metric.ts#L87-L99" - }, - { - "kind": "enum", - "members": [ - { - "description": "Run the aggregation by using global ordinals of the field and resolving those values after finishing a shard.", - "name": "global_ordinals" - }, - { - "description": "Run the aggregation by using segment ordinal values and resolving those values after each segment.", - "name": "segment_ordinals" - }, - { - "description": "Run the aggregation by using field values directly.", - "name": "direct" - }, - { - "description": "Heuristic-based mode, default in Elasticsearch 8.3 and earlier.", - "name": "save_memory_heuristic" - }, - { - "description": "Heuristic-based mode, default in Elasticsearch 8.4 and later.", - "name": "save_time_heuristic" - } - ], - "name": { - "name": "CardinalityExecutionMode", - "namespace": "_types.aggregations" - }, - "specLocation": "_types/aggregations/metric.ts#L64-L85" + "specLocation": "_types/aggregations/bucket.ts#L1240-L1267" }, { - "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.", - "extDocId": "search-aggregations-bucket-categorize-text-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-categorize-text-aggregation.html", - "inherits": { - "type": { - "name": "Aggregation", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "CategorizeTextAggregation", + "name": "FrequentItemSetsField", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The semi-structured text field to categorize.", "name": "field", "required": true, "type": { @@ -64351,49 +67377,88 @@ } }, { - "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.", - "name": "max_unique_tokens", + "description": "Values to exclude.\nCan be regular expression strings or arrays of strings of exact terms.", + "name": "exclude", "required": false, - "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TermsExclude", + "namespace": "_types.aggregations" } } }, { - "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.", - "name": "max_matched_tokens", + "description": "Values to include.\nCan be regular expression strings or arrays of strings of exact terms.", + "name": "include", "required": false, - "serverDefault": 5, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TermsInclude", + "namespace": "_types.aggregations" } } - }, - { - "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.", - "name": "similarity_threshold", - "required": false, - "serverDefault": 50, - "type": { + } + ], + "specLocation": "_types/aggregations/bucket.ts#L1226-L1238" + }, + { + "codegenNames": [ + "regexp", + "terms" + ], + "kind": "type_alias", + "name": { + "name": "TermsExclude", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/bucket.ts#L1077-L1078", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - }, - { - "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.", - "name": "categorization_filters", - "required": false, - "type": { + ], + "kind": "union_of" + } + }, + { + "codegenNames": [ + "regexp", + "terms", + "partition" + ], + "kind": "type_alias", + "name": { + "name": "TermsInclude", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/bucket.ts#L1074-L1075", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { "kind": "array_of", "value": { "kind": "instance_of", @@ -64402,97 +67467,173 @@ "namespace": "_builtins" } } + }, + { + "kind": "instance_of", + "type": { + "name": "TermsPartition", + "namespace": "_types.aggregations" + } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "interface", + "name": { + "name": "TermsPartition", + "namespace": "_types.aggregations" + }, + "properties": [ { - "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 endpoint](https://www.elastic.co/guide/en/elasticsearch/reference/8.0/indices-analyze.html). This property\ncannot be used at the same time as categorization_filters.", - "name": "categorization_analyzer", - "required": false, + "description": "The number of partitions.", + "name": "num_partitions", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CategorizeTextAnalyzer", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } } }, { - "description": "The number of categorization buckets to return from each shard before merging all the results.", - "name": "shard_size", + "description": "The partition number for this request.", + "name": "partition", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/bucket.ts#L1080-L1089" + }, + { + "inherits": { + "type": { + "name": "BucketAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "FiltersAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "description": "Collection of queries from which to build buckets.", + "name": "filters", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + ], "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "Buckets", + "namespace": "_types.aggregations" } } }, { - "description": "The number of buckets to return.", - "name": "size", + "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.", + "name": "other_bucket", "required": false, - "serverDefault": 10, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The minimum number of documents in a bucket to be returned to the results.", - "name": "min_doc_count", + "description": "The key with which the other bucket is returned.", + "name": "other_bucket_key", "required": false, + "serverDefault": "_other_", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The minimum number of documents in a bucket to be returned from the shard before merging.", - "name": "shard_min_doc_count", + "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.", + "name": "keyed", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L1117-L1182" + "specLocation": "_types/aggregations/bucket.ts#L374-L394" }, { "codegenNames": [ - "builtin", - "custom" + "keyed", + "array" + ], + "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.", + "generics": [ + { + "name": "TBucket", + "namespace": "_types.aggregations.Buckets" + } ], "kind": "type_alias", "name": { - "name": "CategorizeTextAnalyzer", + "name": "Buckets", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1184-L1187", + "specLocation": "_types/aggregations/Aggregate.ts#L346-L355", "type": { "items": [ { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "TBucket", + "namespace": "_types.aggregations.Buckets" + } } }, { - "kind": "instance_of", - "type": { - "name": "CustomCategorizeTextAnalyzer", - "namespace": "_types.aggregations" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TBucket", + "namespace": "_types.aggregations.Buckets" + } } } ], @@ -64500,85 +67641,75 @@ } }, { + "extDocId": "search-aggregations-metrics-geobounds-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", + "inherits": { + "type": { + "name": "MetricAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "CustomCategorizeTextAnalyzer", + "name": "GeoBoundsAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "name": "char_filter", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "tokenizer", + "description": "Specifies whether the bounding box should be allowed to overlap the international date line.", + "name": "wrap_longitude", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } - }, - { - "name": "filter", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } } ], - "specLocation": "_types/aggregations/bucket.ts#L1189-L1193" + "specLocation": "_types/aggregations/metric.ts#L108-L117" }, { "inherits": { "type": { - "name": "BucketAggregationBase", + "name": "MetricAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "ChildrenAggregation", + "name": "GeoCentroidAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The child type that should be selected.", - "name": "type", + "name": "count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RelationName", + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "location", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoLocation", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L121-L126" + "specLocation": "_types/aggregations/metric.ts#L119-L122" }, { - "extDocId": "search-aggregations-bucket-composite-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-composite-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -64587,463 +67718,499 @@ }, "kind": "interface", "name": { - "name": "CompositeAggregation", + "name": "GeoDistanceAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "When paginating, use the `after_key` value returned in the previous response to retrieve the next page.", - "name": "after", + "description": "The distance calculation type.", + "name": "distance_type", "required": false, + "serverDefault": "arc", "type": { "kind": "instance_of", "type": { - "name": "CompositeAggregateKey", - "namespace": "_types.aggregations" + "name": "GeoDistanceType", + "namespace": "_types" } } }, { - "description": "The number of composite buckets that should be returned.", - "name": "size", + "description": "A field of type `geo_point` used to evaluate the distance.", + "name": "field", "required": false, - "serverDefault": 10, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Field", "namespace": "_types" } } }, { - "description": "The value sources used to build composite buckets.\nKeys are returned in the order of the `sources` definition.", - "name": "sources", + "description": "The origin used to evaluate the distance.", + "name": "origin", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoLocation", + "namespace": "_types" + } + } + }, + { + "description": "An array of ranges used to bucket documents.", + "name": "ranges", "required": false, "type": { "kind": "array_of", "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "CompositeAggregationSource", - "namespace": "_types.aggregations" - } + "kind": "instance_of", + "type": { + "name": "AggregationRange", + "namespace": "_types.aggregations" } } } + }, + { + "description": "The distance unit.", + "name": "unit", + "required": false, + "serverDefault": "m", + "type": { + "kind": "instance_of", + "type": { + "name": "DistanceUnit", + "namespace": "_types" + } + } } ], - "specLocation": "_types/aggregations/bucket.ts#L130-L149" + "specLocation": "_types/aggregations/bucket.ts#L396-L419" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "CompositeAggregateKey", + "name": "AggregationRange", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L128-L128", - "type": { - "key": { - "kind": "instance_of", + "properties": [ + { + "description": "Start of the range (inclusive).", + "name": "from", + "required": false, "type": { - "name": "Field", - "namespace": "_types" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", + { + "description": "Custom key to return the range with.", + "name": "key", + "required": false, "type": { - "name": "FieldValue", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "End of the range (exclusive).", + "name": "to", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } } - } + ], + "specLocation": "_types/aggregations/bucket.ts#L691-L704" }, { + "extDocId": "search-aggregations-bucket-geohashgrid-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohashgrid-aggregation.html", + "inherits": { + "type": { + "name": "BucketAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "CompositeAggregationSource", + "name": "GeoHashGridAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "A terms aggregation.", - "name": "terms", + "description": "The bounding box to filter the points in each bucket.", + "name": "bounds", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CompositeTermsAggregation", - "namespace": "_types.aggregations" + "name": "GeoBounds", + "namespace": "_types" } } }, { - "description": "A histogram aggregation.", - "name": "histogram", + "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geohash_grid` aggregates all array values.", + "name": "field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CompositeHistogramAggregation", - "namespace": "_types.aggregations" + "name": "Field", + "namespace": "_types" } } }, { - "description": "A date histogram aggregation.", - "name": "date_histogram", + "description": "The string length of the geohashes used to define cells/buckets in the results.", + "name": "precision", "required": false, + "serverDefault": "5", "type": { "kind": "instance_of", "type": { - "name": "CompositeDateHistogramAggregation", - "namespace": "_types.aggregations" + "name": "GeoHashPrecision", + "namespace": "_types" } } }, { - "description": "A geotile grid aggregation.", - "name": "geotile_grid", + "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.", + "name": "shard_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CompositeGeoTileGridAggregation", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "The maximum number of geohash buckets to return.", + "name": "size", + "required": false, + "serverDefault": 10000, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L151-L168" + "specLocation": "_types/aggregations/bucket.ts#L421-L449" }, { - "inherits": { - "type": { - "name": "CompositeAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", + "codegenNames": [ + "geohash_length", + "distance" + ], + "description": "A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like \"1km\", \"10m\".", + "kind": "type_alias", "name": { - "name": "CompositeTermsAggregation", - "namespace": "_types.aggregations" + "name": "GeoHashPrecision", + "namespace": "_types" }, - "properties": [], - "specLocation": "_types/aggregations/bucket.ts#L181-L181" + "specLocation": "_types/Geo.ts#L86-L90", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "number", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } }, { "kind": "interface", "name": { - "name": "CompositeAggregationBase", + "name": "GeoLineAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Either `field` or `script` must be present", - "name": "field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "missing_bucket", - "required": false, + "description": "The name of the geo_point field.", + "name": "point", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "GeoLinePoint", + "namespace": "_types.aggregations" } } }, { - "name": "missing_order", - "required": false, + "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.", + "name": "sort", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MissingOrder", + "name": "GeoLineSort", "namespace": "_types.aggregations" } } }, { - "description": "Either `field` or `script` must be present", - "name": "script", + "description": "When `true`, returns an additional array of the sort values in the feature properties.", + "name": "include_sort", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "value_type", + "description": "The order in which the line is sorted (ascending or descending).", + "name": "sort_order", "required": false, + "serverDefault": "asc", "type": { "kind": "instance_of", "type": { - "name": "ValueType", - "namespace": "_types.aggregations" + "name": "SortOrder", + "namespace": "_types" } } }, { - "name": "order", + "description": "The maximum length of the line represented in the aggregation.\nValid sizes are between 1 and 10000.", + "name": "size", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L170-L179" + "specLocation": "_types/aggregations/metric.ts#L124-L149" }, { - "kind": "enum", - "members": [ - { - "name": "first" - }, - { - "name": "last" - }, - { - "name": "default" - } - ], + "kind": "interface", "name": { - "name": "MissingOrder", + "name": "GeoLinePoint", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/AggregationContainer.ts#L536-L540" - }, - { - "kind": "enum", - "members": [ - { - "name": "string" - }, - { - "name": "long" - }, - { - "name": "double" - }, - { - "name": "number" - }, - { - "name": "date" - }, - { - "name": "date_nanos" - }, - { - "name": "ip" - }, - { - "name": "numeric" - }, - { - "name": "geo_point" - }, + "properties": [ { - "name": "boolean" - } - ], - "name": { - "name": "ValueType", - "namespace": "_types.aggregations" - }, - "specLocation": "_types/aggregations/metric.ts#L436-L447" + "description": "The name of the geo_point field.", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/metric.ts#L158-L163" }, { - "inherits": { - "type": { - "name": "CompositeAggregationBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "CompositeHistogramAggregation", + "name": "GeoLineSort", "namespace": "_types.aggregations" }, "properties": [ { - "name": "interval", + "description": "The name of the numeric field to use as the sort key for ordering the points.", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Field", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L183-L185" + "specLocation": "_types/aggregations/metric.ts#L151-L156" }, { "inherits": { "type": { - "name": "CompositeAggregationBase", + "name": "BucketAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "CompositeDateHistogramAggregation", + "name": "GeoTileGridAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "name": "format", + "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geotile_grid` aggregates all array values.", + "name": "field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "description": "Either `calendar_interval` or `fixed_interval` must be present", - "name": "calendar_interval", + "description": "Integer zoom of the key used to define cells/buckets in the results.\nValues outside of the range [0,29] will be rejected.", + "name": "precision", "required": false, + "serverDefault": "7", "type": { "kind": "instance_of", "type": { - "name": "DurationLarge", + "name": "GeoTilePrecision", "namespace": "_types" } } }, { - "description": "Either `calendar_interval` or `fixed_interval` must be present", - "name": "fixed_interval", + "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.", + "name": "shard_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DurationLarge", + "name": "integer", "namespace": "_types" } } }, { - "name": "offset", + "description": "The maximum number of buckets to return.", + "name": "size", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } }, { - "name": "time_zone", + "description": "A bounding box to filter the geo-points or geo-shapes in each bucket.", + "name": "bounds", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TimeZone", + "name": "GeoBounds", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L187-L195" + "specLocation": "_types/aggregations/bucket.ts#L451-L477" }, { - "description": "A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and\n`y` (year)", "kind": "type_alias", "name": { - "name": "DurationLarge", + "name": "GeoTilePrecision", "namespace": "_types" }, - "specLocation": "_types/Time.ts#L60-L65", + "specLocation": "_types/Geo.ts#L84-L84", "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "number", "namespace": "_builtins" } } }, - { - "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.", - "docId": "time-value", - "docUrl": "https://github.com/elastic/elasticsearch/blob/current/libs/core/src/main/java/org/elasticsearch/core/TimeValue.java", - "kind": "type_alias", - "name": { - "name": "Duration", - "namespace": "_types" - }, - "specLocation": "_types/Time.ts#L52-L58", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "literal_value", - "value": -1 - }, - { - "kind": "literal_value", - "value": 0 - } - ], - "kind": "union_of" - } - }, { "inherits": { "type": { - "name": "CompositeAggregationBase", + "name": "BucketAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "CompositeGeoTileGridAggregation", + "name": "GeohexGridAggregation", "namespace": "_types.aggregations" }, "properties": [ { + "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geohex_grid` aggregates all array values.", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Integer zoom of the key used to defined cells or buckets\nin the results. Value should be between 0-15.", "name": "precision", "required": false, + "serverDefault": 6, "type": { "kind": "instance_of", "type": { @@ -65053,6 +68220,7 @@ } }, { + "description": "Bounding box used to filter the geo-points in each bucket.", "name": "bounds", "required": false, "type": { @@ -65062,43 +68230,49 @@ "namespace": "_types" } } + }, + { + "description": "Maximum number of buckets to return.", + "name": "size", + "required": false, + "serverDefault": 10000, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Number of buckets returned from each shard.", + "name": "shard_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } ], - "specLocation": "_types/aggregations/bucket.ts#L197-L200" - }, - { - "extDocId": "search-aggregations-pipeline-cumulative-cardinality-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", - "inherits": { - "type": { - "name": "PipelineAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "CumulativeCardinalityAggregation", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L206-L209" + "specLocation": "_types/aggregations/bucket.ts#L479-L504" }, { - "extDocId": "search-aggregations-pipeline-cumulative-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-sum-aggregation.html", "inherits": { "type": { - "name": "PipelineAggregationBase", + "name": "BucketAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "CumulativeSumAggregation", + "name": "GlobalAggregation", "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L211-L214" + "specLocation": "_types/aggregations/bucket.ts#L506-L506" }, { "inherits": { @@ -65109,22 +68283,10 @@ }, "kind": "interface", "name": { - "name": "DateHistogramAggregation", + "name": "HistogramAggregation", "namespace": "_types.aggregations" }, "properties": [ - { - "description": "Calendar-aware interval.\nCan be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`.", - "name": "calendar_interval", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "CalendarInterval", - "namespace": "_types.aggregations" - } - } - }, { "description": "Enables extending the bounds of the histogram beyond the data itself.", "name": "extended_bounds", @@ -65134,8 +68296,8 @@ { "kind": "instance_of", "type": { - "name": "FieldDateMath", - "namespace": "_types.aggregations" + "name": "double", + "namespace": "_types" } } ], @@ -65147,7 +68309,7 @@ } }, { - "description": "Limits the histogram to specified 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.", "name": "hard_bounds", "required": false, "type": { @@ -65155,8 +68317,8 @@ { "kind": "instance_of", "type": { - "name": "FieldDateMath", - "namespace": "_types.aggregations" + "name": "double", + "namespace": "_types" } } ], @@ -65168,7 +68330,7 @@ } }, { - "description": "The date field whose values are use to build a histogram.", + "description": "The name of the field to aggregate on.", "name": "field", "required": false, "type": { @@ -65180,46 +68342,19 @@ } }, { - "description": "Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.", - "name": "fixed_interval", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "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.", - "name": "format", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "deprecation": { - "description": "use `fixed_interval` or `calendar_interval`", - "version": "7.2.0" - }, + "description": "The interval for the buckets.\nMust be a positive decimal.", "name": "interval", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "double", "namespace": "_types" } } }, { - "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.", + "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.", "name": "min_doc_count", "required": false, "type": { @@ -65237,25 +68372,25 @@ "type": { "kind": "instance_of", "type": { - "name": "DateTime", + "name": "double", "namespace": "_types" } } }, { - "description": "Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration.", + "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.", "name": "offset", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "double", "namespace": "_types" } } }, { - "description": "The sort order of the returned buckets.", + "description": "The sort order of the returned buckets.\nBy default, the returned buckets are sorted by their key ascending.", "name": "order", "required": false, "type": { @@ -65266,24 +68401,6 @@ } } }, - { - "name": "params", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, { "name": "script", "required": false, @@ -65296,21 +68413,21 @@ } }, { - "description": "Time zone used for bucketing and rounding.\nDefaults to Coordinated Universal Time (UTC).", - "name": "time_zone", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TimeZone", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.", + "description": "If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys.", "name": "keyed", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -65320,157 +68437,120 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L202-L260" + "specLocation": "_types/aggregations/bucket.ts#L519-L565" }, { - "kind": "enum", - "members": [ - { - "aliases": [ - "1s" - ], - "name": "second" - }, - { - "aliases": [ - "1m" - ], - "name": "minute" - }, - { - "aliases": [ - "1h" - ], - "name": "hour" - }, - { - "aliases": [ - "1d" - ], - "name": "day" - }, - { - "aliases": [ - "1w" - ], - "name": "week" - }, - { - "aliases": [ - "1M" - ], - "name": "month" - }, - { - "aliases": [ - "1q" - ], - "name": "quarter" - }, - { - "aliases": [ - "1y" - ], - "name": "year" + "inherits": { + "type": { + "name": "BucketAggregationBase", + "namespace": "_types.aggregations" } - ], - "name": { - "name": "CalendarInterval", - "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L262-L279" - }, - { - "generics": [ - { - "name": "T", - "namespace": "_types.aggregations.ExtendedBounds" - } - ], "kind": "interface", "name": { - "name": "ExtendedBounds", + "name": "IpRangeAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Maximum value for the bound.", - "name": "max", + "description": "The date field whose values are used to build ranges.", + "name": "field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "T", - "namespace": "_types.aggregations.ExtendedBounds" + "name": "Field", + "namespace": "_types" } } }, { - "description": "Minimum value for the bound.", - "name": "min", + "description": "Array of IP ranges.", + "name": "ranges", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "T", - "namespace": "_types.aggregations.ExtendedBounds" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IpRangeAggregationRange", + "namespace": "_types.aggregations" + } } } } ], - "specLocation": "_types/aggregations/bucket.ts#L508-L517" + "specLocation": "_types/aggregations/bucket.ts#L567-L576" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "AggregateOrder", + "name": "IpRangeAggregationRange", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1052-L1054", - "type": { - "items": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "SortOrder", - "namespace": "_types" + "properties": [ + { + "description": "Start of the range.", + "name": "from", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } } + ], + "kind": "union_of" + } + }, + { + "description": "IP range defined as a CIDR mask.", + "name": "mask", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "array_of", - "value": { - "key": { + } + }, + { + "description": "End of the range.", + "name": "to", + "required": false, + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } }, - "kind": "dictionary_of", - "singleKey": true, - "value": { + { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_types" + "name": "null", + "namespace": "_builtins" } } - } + ], + "kind": "union_of" } - ], - "kind": "union_of" - } + } + ], + "specLocation": "_types/aggregations/bucket.ts#L578-L591" }, { "inherits": { @@ -65481,14 +68561,14 @@ }, "kind": "interface", "name": { - "name": "DateRangeAggregation", + "name": "IpPrefixAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The date field whose values are use to build ranges.", + "description": "The IP address field to aggregation on. The field mapping type must be `ip`.", "name": "field", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -65498,212 +68578,211 @@ } }, { - "description": "The date format used to format `from` and `to` in the response.", - "name": "format", + "description": "Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].\nFor IPv6 addresses the accepted range is [0, 128].", + "name": "prefix_length", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Defines whether the prefix applies to IPv6 addresses.", + "name": "is_ipv6", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", - "name": "missing", + "description": "Defines whether the prefix length is appended to IP address keys in the response.", + "name": "append_prefix_length", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Missing", - "namespace": "_types.aggregations" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Array of date ranges.", - "name": "ranges", + "description": "Defines whether buckets are returned as a hash rather than an array in the response.", + "name": "keyed", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DateRangeExpression", - "namespace": "_types.aggregations" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Time zone used to convert dates from another time zone to UTC.", - "name": "time_zone", - "required": false, + "description": "Minimum number of documents in a bucket for it to be included in the response.", + "name": "min_doc_count", + "required": false, + "serverDefault": 1, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/bucket.ts#L1195-L1224" + }, + { + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "InferenceAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "description": "The ID or alias for the trained model.", + "name": "model_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TimeZone", + "name": "Name", "namespace": "_types" } } }, { - "description": "Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.", - "name": "keyed", + "description": "Contains the inference type and its options.", + "name": "inference_config", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "InferenceConfigContainer", + "namespace": "_types.aggregations" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L281-L307" + "specLocation": "_types/aggregations/pipeline.ts#L225-L234" }, { "kind": "interface", "name": { - "name": "DateRangeExpression", + "name": "InferenceConfigContainer", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Start of the range (inclusive).", - "name": "from", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FieldDateMath", - "namespace": "_types.aggregations" - } - } - }, - { - "description": "Custom key to return the range with.", - "name": "key", + "description": "Regression configuration for inference.", + "name": "regression", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "RegressionInferenceOptions", + "namespace": "ml._types" } } }, { - "description": "End of the range (exclusive).", - "name": "to", + "description": "Classification configuration for inference.", + "name": "classification", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldDateMath", - "namespace": "_types.aggregations" + "name": "ClassificationInferenceOptions", + "namespace": "ml._types" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L318-L331" + "specLocation": "_types/aggregations/pipeline.ts#L236-L242", + "variants": { + "kind": "container" + } }, { - "codegenNames": [ - "expr", - "value" - ], - "description": "A date range limit, represented either as a DateMath expression or a number expressed\naccording to the target field's precision.", - "kind": "type_alias", + "kind": "interface", "name": { - "name": "FieldDateMath", - "namespace": "_types.aggregations" + "name": "RegressionInferenceOptions", + "namespace": "ml._types" }, - "specLocation": "_types/aggregations/bucket.ts#L309-L316", - "type": { - "items": [ - { + "properties": [ + { + "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", + "name": "results_field", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DateMath", + "name": "Field", "namespace": "_types" } - }, - { + } + }, + { + "description": "Specifies the maximum number of feature importance values per document.", + "docId": "ml-feature-importance", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html", + "name": "num_top_feature_importance_values", + "required": false, + "serverDefault": 0, + "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "DateMath", - "namespace": "_types" - }, - "specLocation": "_types/Time.ts#L42-L42", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "inherits": { - "type": { - "name": "PipelineAggregationBase", - "namespace": "_types.aggregations" } - }, - "kind": "interface", - "name": { - "name": "DerivativeAggregation", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L216-L216" + ], + "specLocation": "ml/_types/inference.ts#L82-L91" }, { - "extDocId": "search-aggregations-bucket-diversified-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-diversified-sampler-aggregation.html", - "inherits": { - "type": { - "name": "BucketAggregationBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "DiversifiedSamplerAggregation", - "namespace": "_types.aggregations" + "name": "ClassificationInferenceOptions", + "namespace": "ml._types" }, "properties": [ { - "description": "The type of value used for de-duplication.", - "name": "execution_hint", + "description": "Specifies the number of top class predictions to return. Defaults to 0.", + "name": "num_top_classes", "required": false, - "serverDefault": "global_ordinals", "type": { "kind": "instance_of", "type": { - "name": "SamplerAggregationExecutionHint", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Limits how many documents are permitted per choice of de-duplicating value.", - "name": "max_docs_per_value", + "description": "Specifies the maximum number of feature importance values per document.", + "docId": "ml-feature-importance", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html", + "name": "num_top_feature_importance_values", "required": false, - "serverDefault": 1, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -65713,164 +68792,176 @@ } }, { - "name": "script", + "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.", + "name": "prediction_field_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Limits how many top-scoring documents are collected in the sample processed on each shard.", - "name": "shard_size", + "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", + "name": "results_field", "required": false, - "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The field used to provide values used for de-duplication.", - "name": "field", + "description": "Specifies the field to which the top classes are written. Defaults to top_classes.", + "name": "top_classes_results_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L333-L357" - }, - { - "kind": "enum", - "members": [ - { - "description": "Hold field values directly.", - "name": "map" - }, - { - "description": "Hold ordinals of the field as determined by the Lucene index.", - "name": "global_ordinals" - }, - { - "description": "Hold hashes of the field values - with potential for hash collisions.", - "name": "bytes_hash" - } - ], - "name": { - "name": "SamplerAggregationExecutionHint", - "namespace": "_types.aggregations" - }, - "specLocation": "_types/aggregations/bucket.ts#L359-L372" + "specLocation": "ml/_types/inference.ts#L93-L108" }, { "inherits": { "type": { - "name": "FormatMetricAggregationBase", + "name": "MatrixAggregation", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "ExtendedStatsAggregation", + "name": "MatrixStatsAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The number of standard deviations above/below the mean to display.", - "name": "sigma", + "description": "Array value the aggregation will use for array or multi-valued fields.", + "name": "mode", "required": false, + "serverDefault": "avg", "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "SortMode", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/metric.ts#L101-L106" + "specLocation": "_types/aggregations/matrix.ts#L38-L44" }, { "inherits": { "type": { - "name": "PipelineAggregationBase", + "name": "Aggregation", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "ExtendedStatsBucketAggregation", + "name": "MatrixAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The number of standard deviations above/below the mean to display.", - "name": "sigma", + "description": "An array of fields for computing the statistics.", + "name": "fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Fields", "namespace": "_types" } } + }, + { + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "name": "missing", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + } } ], - "specLocation": "_types/aggregations/pipeline.ts#L218-L223" + "specLocation": "_types/aggregations/matrix.ts#L26-L36" }, { - "extDocId": "search-aggregations-bucket-frequent-item-sets-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-frequent-item-sets-aggregation.html", + "inherits": { + "type": { + "name": "FormatMetricAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "FrequentItemSetsAggregation", + "name": "MaxAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/metric.ts#L165-L165" + }, + { + "extDocId": "search-aggregations-pipeline-max-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-max-bucket-aggregation.html", + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MaxBucketAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L244-L247" + }, + { + "extDocId": "search-aggregations-metrics-median-absolute-deviation-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-median-absolute-deviation-aggregation.html", + "inherits": { + "type": { + "name": "FormatMetricAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MedianAbsoluteDeviationAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Fields to analyze.", - "name": "fields", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FrequentItemSetsField", - "namespace": "_types.aggregations" - } - } - } - }, - { - "description": "The minimum size of one item set.", - "name": "minimum_set_size", - "required": false, - "serverDefault": 1, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The minimum support of one item set.", - "name": "minimum_support", + "description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.", + "name": "compression", "required": false, - "serverDefault": 0.1, + "serverDefault": 1000, "type": { "kind": "instance_of", "type": { @@ -65878,45 +68969,59 @@ "namespace": "_types" } } - }, - { - "description": "The number of top item sets to return.", - "name": "size", - "required": false, - "serverDefault": 10, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Query that filters documents from analysis.", - "name": "filter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } } ], - "specLocation": "_types/aggregations/bucket.ts#L1240-L1267" + "specLocation": "_types/aggregations/metric.ts#L167-L176" }, { + "inherits": { + "type": { + "name": "FormatMetricAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "FrequentItemSetsField", + "name": "MinAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/metric.ts#L178-L178" + }, + { + "extDocId": "search-aggregations-pipeline-min-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-min-bucket-aggregation.html", + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MinBucketAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L249-L252" + }, + { + "inherits": { + "type": { + "name": "BucketAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MissingAggregation", "namespace": "_types.aggregations" }, "properties": [ { + "description": "The name of the field.", "name": "field", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -65926,179 +69031,121 @@ } }, { - "description": "Values to exclude.\nCan be regular expression strings or arrays of strings of exact terms.", - "name": "exclude", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TermsExclude", - "namespace": "_types.aggregations" - } - } - }, - { - "description": "Values to include.\nCan be regular expression strings or arrays of strings of exact terms.", - "name": "include", + "name": "missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermsInclude", + "name": "Missing", "namespace": "_types.aggregations" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L1226-L1238" + "specLocation": "_types/aggregations/bucket.ts#L593-L599" }, { - "codegenNames": [ - "regexp", - "terms" - ], "kind": "type_alias", "name": { - "name": "TermsExclude", + "name": "MovingAverageAggregation", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1077-L1078", + "specLocation": "_types/aggregations/pipeline.ts#L254-L260", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "LinearMovingAverageAggregation", + "namespace": "_types.aggregations" } }, { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "SimpleMovingAverageAggregation", + "namespace": "_types.aggregations" } - } - ], - "kind": "union_of" - } - }, - { - "codegenNames": [ - "regexp", - "terms", - "partition" - ], - "kind": "type_alias", - "name": { - "name": "TermsInclude", - "namespace": "_types.aggregations" - }, - "specLocation": "_types/aggregations/bucket.ts#L1074-L1075", - "type": { - "items": [ + }, { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "EwmaMovingAverageAggregation", + "namespace": "_types.aggregations" } }, { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "HoltMovingAverageAggregation", + "namespace": "_types.aggregations" } }, { "kind": "instance_of", "type": { - "name": "TermsPartition", + "name": "HoltWintersMovingAverageAggregation", "namespace": "_types.aggregations" } } ], "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "tag": "model" } }, { + "inherits": { + "type": { + "name": "MovingAverageAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "TermsPartition", + "name": "LinearMovingAverageAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The number of partitions.", - "name": "num_partitions", + "name": "model", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "kind": "literal_value", + "value": "linear" } }, - { - "description": "The partition number for this request.", - "name": "partition", + { + "name": "settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "EmptyObject", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L1080-L1089" + "specLocation": "_types/aggregations/pipeline.ts#L268-L271" }, { "inherits": { "type": { - "name": "BucketAggregationBase", + "name": "PipelineAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "FiltersAggregation", + "name": "MovingAverageAggregationBase", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Collection of queries from which to build buckets.", - "name": "filters", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - ], - "kind": "instance_of", - "type": { - "name": "Buckets", - "namespace": "_types.aggregations" - } - } - }, - { - "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.", - "name": "other_bucket", + "name": "minimize", "required": false, "type": { "kind": "instance_of", @@ -66109,375 +69156,287 @@ } }, { - "description": "The key with which the other bucket is returned.", - "name": "other_bucket_key", + "name": "predict", "required": false, - "serverDefault": "_other_", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "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.", - "name": "keyed", + "name": "window", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L374-L394" + "specLocation": "_types/aggregations/pipeline.ts#L262-L266" }, { - "codegenNames": [ - "keyed", - "array" - ], - "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.", - "generics": [ - { - "name": "TBucket", - "namespace": "_types.aggregations.Buckets" - } - ], - "kind": "type_alias", + "description": "For empty Class assignments", + "kind": "interface", "name": { - "name": "Buckets", - "namespace": "_types.aggregations" + "name": "EmptyObject", + "namespace": "_types" }, - "specLocation": "_types/aggregations/Aggregate.ts#L346-L355", - "type": { - "items": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "TBucket", - "namespace": "_types.aggregations.Buckets" - } - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TBucket", - "namespace": "_types.aggregations.Buckets" - } - } - } - ], - "kind": "union_of" - } + "properties": [], + "specLocation": "_types/common.ts#L157-L158" }, { - "extDocId": "search-aggregations-metrics-geobounds-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", "inherits": { "type": { - "name": "MetricAggregationBase", + "name": "MovingAverageAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "GeoBoundsAggregation", + "name": "SimpleMovingAverageAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Specifies whether the bounding box should be allowed to overlap the international date line.", - "name": "wrap_longitude", - "required": false, - "serverDefault": true, + "name": "model", + "required": true, + "type": { + "kind": "literal_value", + "value": "simple" + } + }, + { + "name": "settings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "EmptyObject", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/metric.ts#L108-L117" + "specLocation": "_types/aggregations/pipeline.ts#L273-L276" }, { "inherits": { "type": { - "name": "MetricAggregationBase", + "name": "MovingAverageAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "GeoCentroidAggregation", + "name": "EwmaMovingAverageAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "name": "count", - "required": false, + "name": "model", + "required": true, + "type": { + "kind": "literal_value", + "value": "ewma" + } + }, + { + "name": "settings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "EwmaModelSettings", + "namespace": "_types.aggregations" } } - }, + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L278-L281" + }, + { + "kind": "interface", + "name": { + "name": "EwmaModelSettings", + "namespace": "_types.aggregations" + }, + "properties": [ { - "name": "location", + "name": "alpha", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoLocation", + "name": "float", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/metric.ts#L119-L122" + "specLocation": "_types/aggregations/pipeline.ts#L293-L295" }, { "inherits": { "type": { - "name": "BucketAggregationBase", + "name": "MovingAverageAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "GeoDistanceAggregation", + "name": "HoltMovingAverageAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The distance calculation type.", - "name": "distance_type", - "required": false, - "serverDefault": "arc", + "name": "model", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "GeoDistanceType", - "namespace": "_types" - } + "kind": "literal_value", + "value": "holt" } }, { - "description": "A field of type `geo_point` used to evaluate the distance.", - "name": "field", - "required": false, + "name": "settings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "HoltLinearModelSettings", + "namespace": "_types.aggregations" } } - }, + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L283-L286" + }, + { + "kind": "interface", + "name": { + "name": "HoltLinearModelSettings", + "namespace": "_types.aggregations" + }, + "properties": [ { - "description": "The origin used to evaluate the distance.", - "name": "origin", + "name": "alpha", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoLocation", + "name": "float", "namespace": "_types" } } }, { - "description": "An array of ranges used to bucket documents.", - "name": "ranges", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationRange", - "namespace": "_types.aggregations" - } - } - } - }, - { - "description": "The distance unit.", - "name": "unit", + "name": "beta", "required": false, - "serverDefault": "m", "type": { "kind": "instance_of", "type": { - "name": "DistanceUnit", + "name": "float", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L396-L419" + "specLocation": "_types/aggregations/pipeline.ts#L297-L300" }, { + "inherits": { + "type": { + "name": "MovingAverageAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "AggregationRange", + "name": "HoltWintersMovingAverageAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Start of the range (inclusive).", - "name": "from", - "required": false, + "name": "model", + "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "literal_value", + "value": "holt_winters" } }, { - "description": "Custom key to return the range with.", - "name": "key", - "required": false, + "name": "settings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "HoltWintersModelSettings", + "namespace": "_types.aggregations" } } - }, - { - "description": "End of the range (exclusive).", - "name": "to", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } } ], - "specLocation": "_types/aggregations/bucket.ts#L691-L704" + "specLocation": "_types/aggregations/pipeline.ts#L288-L291" }, { - "extDocId": "search-aggregations-bucket-geohashgrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohashgrid-aggregation.html", - "inherits": { - "type": { - "name": "BucketAggregationBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "GeoHashGridAggregation", + "name": "HoltWintersModelSettings", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The bounding box to filter the points in each bucket.", - "name": "bounds", + "name": "alpha", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoBounds", + "name": "float", "namespace": "_types" } } }, { - "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geohash_grid` aggregates all array values.", - "name": "field", + "name": "beta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "float", "namespace": "_types" } } }, { - "description": "The string length of the geohashes used to define cells/buckets in the results.", - "name": "precision", + "name": "gamma", "required": false, - "serverDefault": "5", "type": { "kind": "instance_of", "type": { - "name": "GeoHashPrecision", + "name": "float", "namespace": "_types" } } }, { - "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.", - "name": "shard_size", + "name": "pad", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The maximum number of geohash buckets to return.", - "name": "size", + "name": "period", "required": false, - "serverDefault": 10000, "type": { "kind": "instance_of", "type": { @@ -66485,76 +69444,81 @@ "namespace": "_types" } } + }, + { + "name": "type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "HoltWintersType", + "namespace": "_types.aggregations" + } + } } ], - "specLocation": "_types/aggregations/bucket.ts#L421-L449" + "specLocation": "_types/aggregations/pipeline.ts#L301-L308" }, { - "codegenNames": [ - "geohash_length", - "distance" + "kind": "enum", + "members": [ + { + "codegenName": "Additive", + "name": "add" + }, + { + "codegenName": "Multiplicative", + "name": "mult" + } ], - "description": "A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like \"1km\", \"10m\".", - "kind": "type_alias", "name": { - "name": "GeoHashPrecision", - "namespace": "_types" + "name": "HoltWintersType", + "namespace": "_types.aggregations" }, - "specLocation": "_types/Geo.ts#L86-L90", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "number", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } + "specLocation": "_types/aggregations/pipeline.ts#L309-L312" }, { + "extDocId": "search-aggregations-pipeline-moving-percentiles-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-moving-percentiles-aggregation.html", + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "GeoLineAggregation", + "name": "MovingPercentilesAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The name of the geo_point field.", - "name": "point", - "required": true, + "description": "The size of window to \"slide\" across the histogram.", + "name": "window", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoLinePoint", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } }, { - "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.", - "name": "sort", - "required": true, + "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.", + "name": "shift", + "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "GeoLineSort", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } }, { - "description": "When `true`, returns an additional array of the sort values in the feature properties.", - "name": "include_sort", + "name": "keyed", "required": false, "type": { "kind": "instance_of", @@ -66563,25 +69527,42 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L334-L349" + }, + { + "extDocId": "search-aggregations-pipeline-movfn-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-movfn-aggregation.html", + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MovingFunctionAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ { - "description": "The order in which the line is sorted (ascending or descending).", - "name": "sort_order", + "description": "The script that should be executed on each window of data.", + "name": "script", "required": false, - "serverDefault": "asc", "type": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The maximum length of the line represented in the aggregation.\nValid sizes are between 1 and 10000.", - "name": "size", + "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.", + "name": "shift", "required": false, - "serverDefault": 10000, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -66589,94 +69570,88 @@ "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/metric.ts#L124-L149" - }, - { - "kind": "interface", - "name": { - "name": "GeoLinePoint", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "The name of the geo_point field.", - "name": "field", - "required": true, + "description": "The size of window to \"slide\" across the histogram.", + "name": "window", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/metric.ts#L158-L163" + "specLocation": "_types/aggregations/pipeline.ts#L314-L332" }, { + "inherits": { + "type": { + "name": "BucketAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "GeoLineSort", + "name": "MultiTermsAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The name of the numeric field to use as the sort key for ordering the points.", - "name": "field", - "required": true, + "description": "Specifies the strategy for data collection.", + "name": "collect_mode", + "required": false, + "serverDefault": "breadth_first", "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "TermsAggregationCollectMode", + "namespace": "_types.aggregations" + } + } + }, + { + "description": "Specifies the sort order of the buckets.\nDefaults to sorting by descending document count.", + "name": "order", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AggregateOrder", + "namespace": "_types.aggregations" } } - } - ], - "specLocation": "_types/aggregations/metric.ts#L151-L156" - }, - { - "inherits": { - "type": { - "name": "BucketAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "GeoTileGridAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geotile_grid` aggregates all array values.", - "name": "field", + "description": "The minimum number of documents in a bucket for it to be returned.", + "name": "min_doc_count", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "long", "namespace": "_types" } } }, { - "description": "Integer zoom of the key used to define cells/buckets in the results.\nValues outside of the range [0,29] will be rejected.", - "name": "precision", + "description": "The minimum number of documents in a bucket on each shard for it to be returned.", + "name": "shard_min_doc_count", "required": false, - "serverDefault": "7", + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "GeoTilePrecision", + "name": "long", "namespace": "_types" } } }, { - "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.", + "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.", "name": "shard_size", "required": false, "type": { @@ -66688,63 +69663,76 @@ } }, { - "description": "The maximum number of buckets to return.", - "name": "size", + "description": "Calculates the doc count error on per term basis.", + "name": "show_term_doc_count_error", "required": false, - "serverDefault": 10000, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "A bounding box to filter the geo-points or geo-shapes in each bucket.", - "name": "bounds", + "description": "The number of term buckets should be returned out of the overall terms list.", + "name": "size", "required": false, + "serverDefault": 10, "type": { "kind": "instance_of", "type": { - "name": "GeoBounds", + "name": "integer", "namespace": "_types" } } + }, + { + "description": "The field from which to generate sets of terms.", + "name": "terms", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "MultiTermLookup", + "namespace": "_types.aggregations" + } + } + } } ], - "specLocation": "_types/aggregations/bucket.ts#L451-L477" + "specLocation": "_types/aggregations/bucket.ts#L601-L641" }, { - "kind": "type_alias", + "kind": "enum", + "members": [ + { + "description": "Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs.", + "name": "depth_first" + }, + { + "description": "Caches the set of documents that fall into the uppermost buckets for subsequent replay.", + "name": "breadth_first" + } + ], "name": { - "name": "GeoTilePrecision", - "namespace": "_types" + "name": "TermsAggregationCollectMode", + "namespace": "_types.aggregations" }, - "specLocation": "_types/Geo.ts#L84-L84", - "type": { - "kind": "instance_of", - "type": { - "name": "number", - "namespace": "_builtins" - } - } + "specLocation": "_types/aggregations/bucket.ts#L1056-L1065" }, { - "inherits": { - "type": { - "name": "BucketAggregationBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "GeohexGridAggregation", + "name": "MultiTermLookup", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Field containing indexed `geo_point` or `geo_shape` values.\nIf the field contains an array, `geohex_grid` aggregates all array values.", + "description": "A fields from which to retrieve terms.", "name": "field", "required": true, "type": { @@ -66756,57 +69744,112 @@ } }, { - "description": "Integer zoom of the key used to defined cells or buckets\nin the results. Value should be between 0-15.", - "name": "precision", + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "name": "missing", "required": false, - "serverDefault": 6, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "Missing", + "namespace": "_types.aggregations" } } - }, + } + ], + "specLocation": "_types/aggregations/bucket.ts#L643-L653" + }, + { + "inherits": { + "type": { + "name": "BucketAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "NestedAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ { - "description": "Bounding box used to filter the geo-points in each bucket.", - "name": "bounds", + "description": "The path to the field of type `nested`.", + "name": "path", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoBounds", + "name": "Field", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/aggregations/bucket.ts#L655-L660" + }, + { + "extDocId": "search-aggregations-pipeline-normalize-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-normalize-aggregation.html", + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "NormalizeAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ { - "description": "Maximum number of buckets to return.", - "name": "size", + "description": "The specific method to apply.", + "name": "method", "required": false, - "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "NormalizeMethod", + "namespace": "_types.aggregations" } } + } + ], + "specLocation": "_types/aggregations/pipeline.ts#L351-L359" + }, + { + "kind": "enum", + "members": [ + { + "description": "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.", + "name": "rescale_0_1" }, { - "description": "Number of buckets returned from each shard.", - "name": "shard_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "description": "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.", + "name": "rescale_0_100" + }, + { + "description": "This method normalizes each value so that it represents a percentage of the total sum it attributes to.", + "name": "percent_of_sum" + }, + { + "description": "This method normalizes such that each value is normalized by how much it differs from the average.", + "name": "mean" + }, + { + "codegenName": "z_score", + "description": "This method normalizes such that each value represents how far it is from the mean relative to the standard deviation.", + "name": "z-score" + }, + { + "description": "This method normalizes such that each value is exponentiated and relative to the sum of the exponents of the original values.", + "name": "softmax" } ], - "specLocation": "_types/aggregations/bucket.ts#L479-L504" + "name": { + "name": "NormalizeMethod", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/pipeline.ts#L361-L387" }, { "inherits": { @@ -66817,94 +69860,117 @@ }, "kind": "interface", "name": { - "name": "GlobalAggregation", + "name": "ParentAggregation", "namespace": "_types.aggregations" }, - "properties": [], - "specLocation": "_types/aggregations/bucket.ts#L506-L506" + "properties": [ + { + "description": "The child type that should be selected.", + "name": "type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RelationName", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/aggregations/bucket.ts#L662-L667" }, { + "extDocId": "search-aggregations-metrics-percentile-rank-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html", "inherits": { "type": { - "name": "BucketAggregationBase", + "name": "FormatMetricAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "HistogramAggregation", + "name": "PercentileRanksAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Enables extending the bounds of the histogram beyond the data itself.", - "name": "extended_bounds", + "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.", + "name": "keyed", "required": false, + "serverDefault": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "ExtendedBounds", - "namespace": "_types.aggregations" + "name": "boolean", + "namespace": "_builtins" } } }, { - "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.", - "name": "hard_bounds", + "description": "An array of values for which to calculate the percentile ranks.", + "name": "values", "required": false, "type": { - "generics": [ + "items": [ + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "null", + "namespace": "_builtins" } } ], - "kind": "instance_of", - "type": { - "name": "ExtendedBounds", - "namespace": "_types.aggregations" - } + "kind": "union_of" } }, { - "description": "The name of the field to aggregate on.", - "name": "field", + "description": "Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.", + "name": "hdr", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "HdrMethod", + "namespace": "_types.aggregations" } } }, { - "description": "The interval for the buckets.\nMust be a positive decimal.", - "name": "interval", + "description": "Sets parameters for the default TDigest algorithm used to calculate percentile ranks.", + "name": "tdigest", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "TDigest", + "namespace": "_types.aggregations" } } - }, + } + ], + "specLocation": "_types/aggregations/metric.ts#L180-L202" + }, + { + "kind": "interface", + "name": { + "name": "HdrMethod", + "namespace": "_types.aggregations" + }, + "properties": [ { - "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.", - "name": "min_doc_count", + "description": "Specifies the resolution of values for the histogram in number of significant digits.", + "name": "number_of_significant_value_digits", "required": false, "type": { "kind": "instance_of", @@ -66913,193 +69979,132 @@ "namespace": "_types" } } - }, - { - "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", - "name": "missing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, + } + ], + "specLocation": "_types/aggregations/metric.ts#L225-L230" + }, + { + "kind": "interface", + "name": { + "name": "TDigest", + "namespace": "_types.aggregations" + }, + "properties": [ { - "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.", - "name": "offset", + "description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.", + "name": "compression", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/aggregations/metric.ts#L232-L237" + }, + { + "inherits": { + "type": { + "name": "FormatMetricAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "PercentilesAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ { - "description": "The sort order of the returned buckets.\nBy default, the returned buckets are sorted by their key ascending.", - "name": "order", + "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.", + "name": "keyed", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "AggregateOrder", - "namespace": "_types.aggregations" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "script", + "description": "The percentiles to calculate.", + "name": "percents", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } } }, { - "name": "format", + "description": "Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.", + "name": "hdr", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "HdrMethod", + "namespace": "_types.aggregations" } } }, { - "description": "If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys.", - "name": "keyed", + "description": "Sets parameters for the default TDigest algorithm used to calculate percentiles.", + "name": "tdigest", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "TDigest", + "namespace": "_types.aggregations" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L519-L565" + "specLocation": "_types/aggregations/metric.ts#L204-L223" }, { + "extDocId": "search-aggregations-pipeline-percentiles-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-percentiles-bucket-aggregation.html", "inherits": { "type": { - "name": "BucketAggregationBase", + "name": "PipelineAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "IpRangeAggregation", + "name": "PercentilesBucketAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The date field whose values are used to build ranges.", - "name": "field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "Array of IP ranges.", - "name": "ranges", + "description": "The list of percentiles to calculate.", + "name": "percents", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "IpRangeAggregationRange", - "namespace": "_types.aggregations" - } - } - } - } - ], - "specLocation": "_types/aggregations/bucket.ts#L567-L576" - }, - { - "kind": "interface", - "name": { - "name": "IpRangeAggregationRange", - "namespace": "_types.aggregations" - }, - "properties": [ - { - "description": "Start of the range.", - "name": "from", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } + "name": "double", + "namespace": "_types" } - ], - "kind": "union_of" - } - }, - { - "description": "IP range defined as a CIDR mask.", - "name": "mask", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" } } - }, - { - "description": "End of the range.", - "name": "to", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } } ], - "specLocation": "_types/aggregations/bucket.ts#L578-L591" + "specLocation": "_types/aggregations/pipeline.ts#L389-L397" }, { "inherits": { @@ -67110,14 +70115,14 @@ }, "kind": "interface", "name": { - "name": "IpPrefixAggregation", + "name": "RangeAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The IP address field to aggregation on. The field mapping type must be `ip`.", + "description": "The date field whose values are use to build ranges.", "name": "field", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -67126,10 +70131,10 @@ } } }, - { - "description": "Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].\nFor IPv6 addresses the accepted range is [0, 128].", - "name": "prefix_length", - "required": true, + { + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "name": "missing", + "required": false, "type": { "kind": "instance_of", "type": { @@ -67139,33 +70144,33 @@ } }, { - "description": "Defines whether the prefix applies to IPv6 addresses.", - "name": "is_ipv6", + "description": "An array of ranges used to bucket documents.", + "name": "ranges", "required": false, - "serverDefault": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AggregationRange", + "namespace": "_types.aggregations" + } } } }, { - "description": "Defines whether the prefix length is appended to IP address keys in the response.", - "name": "append_prefix_length", + "name": "script", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Script", + "namespace": "_types" } } }, { - "description": "Defines whether buckets are returned as a hash rather than an array in the response.", + "description": "Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.", "name": "keyed", "required": false, "type": { @@ -67177,306 +70182,368 @@ } }, { - "description": "Minimum number of documents in a bucket for it to be included in the response.", - "name": "min_doc_count", + "name": "format", "required": false, - "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L1195-L1224" + "specLocation": "_types/aggregations/bucket.ts#L669-L689" }, { + "extDocId": "search-aggregations-bucket-rare-terms-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-rare-terms-aggregation.html", "inherits": { "type": { - "name": "PipelineAggregationBase", + "name": "BucketAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "InferenceAggregation", + "name": "RareTermsAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The ID or alias for the trained model.", - "name": "model_id", - "required": true, + "description": "Terms that should be excluded from the aggregation.", + "name": "exclude", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "TermsExclude", + "namespace": "_types.aggregations" + } + } + }, + { + "description": "The field from which to return rare terms.", + "name": "field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", "namespace": "_types" } } }, { - "description": "Contains the inference type and its options.", - "name": "inference_config", + "description": "Terms that should be included in the aggregation.", + "name": "include", "required": false, "type": { "kind": "instance_of", "type": { - "name": "InferenceConfigContainer", + "name": "TermsInclude", "namespace": "_types.aggregations" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L225-L234" - }, - { - "kind": "interface", - "name": { - "name": "InferenceConfigContainer", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "Regression configuration for inference.", - "name": "regression", + "description": "The maximum number of documents a term should appear in.", + "name": "max_doc_count", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "RegressionInferenceOptions", - "namespace": "ml._types" + "name": "long", + "namespace": "_types" } } }, { - "description": "Classification configuration for inference.", - "name": "classification", + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "name": "missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClassificationInferenceOptions", - "namespace": "ml._types" + "name": "Missing", + "namespace": "_types.aggregations" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L236-L242", - "variants": { - "kind": "container" - } - }, - { - "kind": "interface", - "name": { - "name": "RegressionInferenceOptions", - "namespace": "ml._types" - }, - "properties": [ + }, { - "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", - "name": "results_field", + "description": "The precision of the internal CuckooFilters.\nSmaller precision leads to better approximation, but higher memory usage.", + "name": "precision", "required": false, + "serverDefault": 0.001, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "double", "namespace": "_types" } } }, { - "description": "Specifies the maximum number of feature importance values per document.", - "docId": "ml-feature-importance", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html", - "name": "num_top_feature_importance_values", + "name": "value_type", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "ml/_types/inference.ts#L82-L91" + "specLocation": "_types/aggregations/bucket.ts#L706-L739" }, { + "inherits": { + "type": { + "name": "FormatMetricAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "ClassificationInferenceOptions", - "namespace": "ml._types" + "name": "RateAggregation", + "namespace": "_types.aggregations" }, "properties": [ { - "description": "Specifies the number of top class predictions to return. Defaults to 0.", - "name": "num_top_classes", + "description": "The interval used to calculate the rate.\nBy default, the interval of the `date_histogram` is used.", + "name": "unit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "CalendarInterval", + "namespace": "_types.aggregations" } } }, { - "description": "Specifies the maximum number of feature importance values per document.", - "docId": "ml-feature-importance", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html", - "name": "num_top_feature_importance_values", + "description": "How the rate is calculated.", + "name": "mode", "required": false, - "serverDefault": 0, + "serverDefault": "sum", "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "RateMode", + "namespace": "_types.aggregations" } } + } + ], + "specLocation": "_types/aggregations/metric.ts#L239-L250" + }, + { + "kind": "enum", + "members": [ + { + "description": "Calculates the sum of all values of the field.", + "name": "sum" }, { - "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.", - "name": "prediction_field_type", + "description": "Uses the number of values of the field.", + "name": "value_count" + } + ], + "name": { + "name": "RateMode", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/metric.ts#L252-L261" + }, + { + "inherits": { + "type": { + "name": "BucketAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "ReverseNestedAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "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.", + "name": "path", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/aggregations/bucket.ts#L741-L747" + }, + { + "extDocId": "search-aggregations-random-sampler-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-random-sampler-aggregation.html", + "inherits": { + "type": { + "name": "BucketAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "RandomSamplerAggregation", + "namespace": "_types.aggregations" + }, + "properties": [ { - "description": "The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.", - "name": "results_field", - "required": false, + "description": "The probability that a document will be included in the aggregated data.\nMust be greater than 0, less than 0.5, or exactly 1.\nThe lower the probability, the fewer documents are matched.", + "name": "probability", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "description": "Specifies the field to which the top classes are written. Defaults to top_classes.", - "name": "top_classes_results_field", + "description": "The seed to generate the random sampling of documents.\nWhen a seed is provided, the random subset of documents is the same between calls.", + "name": "seed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "ml/_types/inference.ts#L93-L108" + "specLocation": "_types/aggregations/bucket.ts#L749-L769" }, { + "extDocId": "search-aggregations-bucket-sampler-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-sampler-aggregation.html", "inherits": { "type": { - "name": "MatrixAggregation", + "name": "BucketAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "MatrixStatsAggregation", + "name": "SamplerAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Array value the aggregation will use for array or multi-valued fields.", - "name": "mode", + "description": "Limits how many top-scoring documents are collected in the sample processed on each shard.", + "name": "shard_size", "required": false, - "serverDefault": "avg", + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "SortMode", + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/matrix.ts#L38-L44" + "specLocation": "_types/aggregations/bucket.ts#L771-L780" }, { "inherits": { "type": { - "name": "Aggregation", + "name": "MetricAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "MatrixAggregation", + "name": "ScriptedMetricAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "An array of fields for computing the statistics.", - "name": "fields", + "description": "Runs once on each shard after document collection is complete.\nAllows the aggregation to consolidate the state returned from each shard.", + "name": "combine_script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "Script", "namespace": "_types" } } }, { - "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", - "name": "missing", + "description": "Runs prior to any collection of documents.\nAllows the aggregation to set up any initial state.", + "name": "init_script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } + }, + { + "description": "Run once per document collected.\nIf no `combine_script` is specified, the resulting state needs to be stored in the `state` object.", + "name": "map_script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } + }, + { + "description": "A global object with script parameters for `init`, `map` and `combine` scripts.\nIt is shared between the scripts.", + "name": "params", "required": false, "type": { "key": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } }, "kind": "dictionary_of", "singleKey": false, "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "kind": "user_defined_value" + } + } + }, + { + "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.", + "name": "reduce_script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/matrix.ts#L26-L36" - }, - { - "inherits": { - "type": { - "name": "FormatMetricAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "MaxAggregation", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/metric.ts#L165-L165" + "specLocation": "_types/aggregations/metric.ts#L263-L289" }, { - "extDocId": "search-aggregations-pipeline-max-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-max-bucket-aggregation.html", + "extDocId": "search-aggregations-pipeline-serialdiff-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-serialdiff-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -67485,76 +70552,28 @@ }, "kind": "interface", "name": { - "name": "MaxBucketAggregation", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L244-L247" - }, - { - "extDocId": "search-aggregations-metrics-median-absolute-deviation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-median-absolute-deviation-aggregation.html", - "inherits": { - "type": { - "name": "FormatMetricAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "MedianAbsoluteDeviationAggregation", + "name": "SerialDifferencingAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.", - "name": "compression", + "description": "The historical bucket to subtract from the current value.\nMust be a positive, non-zero integer.", + "name": "lag", "required": false, - "serverDefault": 1000, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/metric.ts#L167-L176" - }, - { - "inherits": { - "type": { - "name": "FormatMetricAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "MinAggregation", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/metric.ts#L178-L178" - }, - { - "extDocId": "search-aggregations-pipeline-min-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-min-bucket-aggregation.html", - "inherits": { - "type": { - "name": "PipelineAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "MinBucketAggregation", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L249-L252" + "specLocation": "_types/aggregations/pipeline.ts#L399-L408" }, { + "extDocId": "search-aggregations-bucket-significanttext-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -67563,12 +70582,60 @@ }, "kind": "interface", "name": { - "name": "MissingAggregation", + "name": "SignificantTermsAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The name of the field.", + "description": "A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.", + "name": "background_filter", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + }, + { + "description": "Use Chi square, as described in \"Information Retrieval\", Manning et al., Chapter 13.5.2, as the significance score.", + "name": "chi_square", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ChiSquareHeuristic", + "namespace": "_types.aggregations" + } + } + }, + { + "description": "Terms to exclude.", + "name": "exclude", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TermsExclude", + "namespace": "_types.aggregations" + } + } + }, + { + "description": "Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.", + "name": "execution_hint", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TermsAggregationExecutionHint", + "namespace": "_types.aggregations" + } + } + }, + { + "description": "The field from which to return significant terms.", "name": "field", "required": false, "type": { @@ -67580,121 +70647,195 @@ } }, { - "name": "missing", + "description": "Use Google normalized distance as described in \"The Google Similarity Distance\", Cilibrasi and Vitanyi, 2007, as the significance score.", + "name": "gnd", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Missing", + "name": "GoogleNormalizedDistanceHeuristic", + "namespace": "_types.aggregations" + } + } + }, + { + "description": "Terms to include.", + "name": "include", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TermsInclude", + "namespace": "_types.aggregations" + } + } + }, + { + "description": "Use JLH score as the significance score.", + "name": "jlh", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "EmptyObject", + "namespace": "_types" + } + } + }, + { + "description": "Only return terms that are found in more than `min_doc_count` hits.", + "name": "min_doc_count", + "required": false, + "serverDefault": 3, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Use mutual information as described in \"Information Retrieval\", Manning et al., Chapter 13.5.1, as the significance score.", + "name": "mutual_information", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MutualInformationHeuristic", "namespace": "_types.aggregations" } } - } - ], - "specLocation": "_types/aggregations/bucket.ts#L593-L599" - }, - { - "kind": "type_alias", - "name": { - "name": "MovingAverageAggregation", - "namespace": "_types.aggregations" - }, - "specLocation": "_types/aggregations/pipeline.ts#L254-L260", - "type": { - "items": [ - { + }, + { + "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.", + "name": "percentage", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "LinearMovingAverageAggregation", + "name": "PercentageScoreHeuristic", "namespace": "_types.aggregations" } - }, - { + } + }, + { + "description": "Customized score, implemented via a script.", + "name": "script_heuristic", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SimpleMovingAverageAggregation", + "name": "ScriptedHeuristic", "namespace": "_types.aggregations" } - }, - { + } + }, + { + "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`.", + "name": "shard_min_doc_count", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "EwmaMovingAverageAggregation", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } - }, - { + } + }, + { + "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.", + "name": "shard_size", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "HoltMovingAverageAggregation", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } - }, - { + } + }, + { + "description": "The number of buckets returned out of the overall terms list.", + "name": "size", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "HoltWintersMovingAverageAggregation", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } - ], - "kind": "union_of" - }, - "variants": { - "kind": "internal_tag", - "tag": "model" - } + } + ], + "specLocation": "_types/aggregations/bucket.ts#L817-L884" }, { - "inherits": { - "type": { - "name": "MovingAverageAggregationBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "LinearMovingAverageAggregation", + "name": "ChiSquareHeuristic", "namespace": "_types.aggregations" }, "properties": [ { - "name": "model", + "description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.", + "name": "background_is_superset", "required": true, "type": { - "kind": "literal_value", - "value": "linear" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } }, { - "name": "settings", + "description": "Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset.", + "name": "include_negatives", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EmptyObject", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "_types/aggregations/pipeline.ts#L268-L271" + "specLocation": "_types/aggregations/bucket.ts#L782-L791" }, { - "inherits": { - "type": { - "name": "PipelineAggregationBase", - "namespace": "_types.aggregations" + "kind": "enum", + "members": [ + { + "name": "map" + }, + { + "name": "global_ordinals" + }, + { + "name": "global_ordinals_hash" + }, + { + "name": "global_ordinals_low_cardinality" } + ], + "name": { + "name": "TermsAggregationExecutionHint", + "namespace": "_types.aggregations" }, + "specLocation": "_types/aggregations/bucket.ts#L1067-L1072" + }, + { "kind": "interface", "name": { - "name": "MovingAverageAggregationBase", + "name": "GoogleNormalizedDistanceHeuristic", "namespace": "_types.aggregations" }, "properties": [ { - "name": "minimize", + "description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.", + "name": "background_is_superset", "required": false, "type": { "kind": "instance_of", @@ -67703,347 +70844,261 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/aggregations/bucket.ts#L793-L798" + }, + { + "kind": "interface", + "name": { + "name": "MutualInformationHeuristic", + "namespace": "_types.aggregations" + }, + "properties": [ { - "name": "predict", + "description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.", + "name": "background_is_superset", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "window", + "description": "Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset.", + "name": "include_negatives", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "_types/aggregations/pipeline.ts#L262-L266" + "specLocation": "_types/aggregations/bucket.ts#L800-L809" }, { - "description": "For empty Class assignments", "kind": "interface", "name": { - "name": "EmptyObject", - "namespace": "_types" + "name": "PercentageScoreHeuristic", + "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/common.ts#L157-L158" + "specLocation": "_types/aggregations/bucket.ts#L811-L811" }, { - "inherits": { - "type": { - "name": "MovingAverageAggregationBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "SimpleMovingAverageAggregation", + "name": "ScriptedHeuristic", "namespace": "_types.aggregations" }, "properties": [ { - "name": "model", - "required": true, - "type": { - "kind": "literal_value", - "value": "simple" - } - }, - { - "name": "settings", + "name": "script", "required": true, "type": { "kind": "instance_of", "type": { - "name": "EmptyObject", + "name": "Script", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/pipeline.ts#L273-L276" + "specLocation": "_types/aggregations/bucket.ts#L813-L815" }, { + "extDocId": "search-aggregations-bucket-significanttext-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", "inherits": { "type": { - "name": "MovingAverageAggregationBase", + "name": "BucketAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "EwmaMovingAverageAggregation", + "name": "SignificantTextAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "name": "model", - "required": true, + "description": "A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.", + "name": "background_filter", + "required": false, "type": { - "kind": "literal_value", - "value": "ewma" + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } } }, { - "name": "settings", - "required": true, + "description": "Use Chi square, as described in \"Information Retrieval\", Manning et al., Chapter 13.5.2, as the significance score.", + "name": "chi_square", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EwmaModelSettings", + "name": "ChiSquareHeuristic", "namespace": "_types.aggregations" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L278-L281" - }, - { - "kind": "interface", - "name": { - "name": "EwmaModelSettings", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "alpha", + "description": "Values to exclude.", + "name": "exclude", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "TermsExclude", + "namespace": "_types.aggregations" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L293-L295" - }, - { - "inherits": { - "type": { - "name": "MovingAverageAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "HoltMovingAverageAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ - { - "name": "model", - "required": true, - "type": { - "kind": "literal_value", - "value": "holt" - } }, { - "name": "settings", - "required": true, + "description": "Determines whether the aggregation will use field values directly or global ordinals.", + "name": "execution_hint", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "HoltLinearModelSettings", + "name": "TermsAggregationExecutionHint", "namespace": "_types.aggregations" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L283-L286" - }, - { - "kind": "interface", - "name": { - "name": "HoltLinearModelSettings", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "alpha", + "description": "The field from which to return significant text.", + "name": "field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "Field", "namespace": "_types" } } }, { - "name": "beta", + "description": "Whether to out duplicate text to deal with noisy data.", + "name": "filter_duplicate_text", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L297-L300" - }, - { - "inherits": { - "type": { - "name": "MovingAverageAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "HoltWintersMovingAverageAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "model", - "required": true, + "description": "Use Google normalized distance as described in \"The Google Similarity Distance\", Cilibrasi and Vitanyi, 2007, as the significance score.", + "name": "gnd", + "required": false, "type": { - "kind": "literal_value", - "value": "holt_winters" + "kind": "instance_of", + "type": { + "name": "GoogleNormalizedDistanceHeuristic", + "namespace": "_types.aggregations" + } } }, { - "name": "settings", - "required": true, + "description": "Values to include.", + "name": "include", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "HoltWintersModelSettings", + "name": "TermsInclude", "namespace": "_types.aggregations" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L288-L291" - }, - { - "kind": "interface", - "name": { - "name": "HoltWintersModelSettings", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "alpha", + "description": "Use JLH score as the significance score.", + "name": "jlh", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "EmptyObject", "namespace": "_types" } } }, { - "name": "beta", + "description": "Only return values that are found in more than `min_doc_count` hits.", + "name": "min_doc_count", "required": false, + "serverDefault": 3, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "long", "namespace": "_types" } } }, { - "name": "gamma", + "description": "Use mutual information as described in \"Information Retrieval\", Manning et al., Chapter 13.5.1, as the significance score.", + "name": "mutual_information", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "MutualInformationHeuristic", + "namespace": "_types.aggregations" } } }, { - "name": "pad", + "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.", + "name": "percentage", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "PercentageScoreHeuristic", + "namespace": "_types.aggregations" } } }, { - "name": "period", + "description": "Customized score, implemented via a script.", + "name": "script_heuristic", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "ScriptedHeuristic", + "namespace": "_types.aggregations" } } }, { - "name": "type", + "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`.", + "name": "shard_min_doc_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "HoltWintersType", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L301-L308" - }, - { - "kind": "enum", - "members": [ - { - "codegenName": "Additive", - "name": "add" }, { - "codegenName": "Multiplicative", - "name": "mult" - } - ], - "name": { - "name": "HoltWintersType", - "namespace": "_types.aggregations" - }, - "specLocation": "_types/aggregations/pipeline.ts#L309-L312" - }, - { - "extDocId": "search-aggregations-pipeline-moving-percentiles-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-moving-percentiles-aggregation.html", - "inherits": { - "type": { - "name": "PipelineAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "MovingPercentilesAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ - { - "description": "The size of window to \"slide\" across the histogram.", - "name": "window", + "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.", + "name": "shard_size", "required": false, "type": { "kind": "instance_of", @@ -68054,10 +71109,9 @@ } }, { - "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.", - "name": "shift", + "description": "The number of buckets returned out of the overall terms list.", + "name": "size", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -68067,22 +71121,36 @@ } }, { - "name": "keyed", + "description": "Overrides the JSON `_source` fields from which text will be analyzed.", + "name": "source_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Fields", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/pipeline.ts#L334-L349" + "specLocation": "_types/aggregations/bucket.ts#L886-L961" + }, + { + "inherits": { + "type": { + "name": "FormatMetricAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "StatsAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/metric.ts#L291-L291" }, { - "extDocId": "search-aggregations-pipeline-movfn-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-movfn-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -68091,51 +71159,76 @@ }, "kind": "interface", "name": { - "name": "MovingFunctionAggregation", + "name": "StatsBucketAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L410-L410" + }, + { + "inherits": { + "type": { + "name": "MetricAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "StringStatsAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The script that should be executed on each window of data.", - "name": "script", + "description": "Shows the probability distribution for all characters.", + "name": "show_distribution", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } - }, - { - "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.", - "name": "shift", - "required": false, - "serverDefault": 0, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The size of window to \"slide\" across the histogram.", - "name": "window", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } } - ], - "specLocation": "_types/aggregations/pipeline.ts#L314-L332" + ], + "specLocation": "_types/aggregations/metric.ts#L293-L299" + }, + { + "inherits": { + "type": { + "name": "FormatMetricAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SumAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/metric.ts#L301-L301" + }, + { + "extDocId": "search-aggregations-pipeline-sum-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-sum-bucket-aggregation.html", + "inherits": { + "type": { + "name": "PipelineAggregationBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SumBucketAggregation", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/pipeline.ts#L412-L415" }, { + "extDocId": "search-aggregations-bucket-terms-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -68144,15 +71237,14 @@ }, "kind": "interface", "name": { - "name": "MultiTermsAggregation", + "name": "TermsAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Specifies the strategy for data collection.", + "description": "Determines how child aggregations should be calculated: breadth-first or depth-first.", "name": "collect_mode", "required": false, - "serverDefault": "breadth_first", "type": { "kind": "instance_of", "type": { @@ -68162,47 +71254,58 @@ } }, { - "description": "Specifies the sort order of the buckets.\nDefaults to sorting by descending document count.", - "name": "order", + "description": "Values to exclude.\nAccepts regular expressions and partitions.", + "name": "exclude", "required": false, "type": { "kind": "instance_of", "type": { - "name": "AggregateOrder", + "name": "TermsExclude", "namespace": "_types.aggregations" } } }, { - "description": "The minimum number of documents in a bucket for it to be returned.", - "name": "min_doc_count", + "description": "Determines whether the aggregation will use field values directly or global ordinals.", + "name": "execution_hint", "required": false, - "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "TermsAggregationExecutionHint", + "namespace": "_types.aggregations" } } }, { - "description": "The minimum number of documents in a bucket on each shard for it to be returned.", - "name": "shard_min_doc_count", + "description": "The field from which to return terms.", + "name": "field", "required": false, - "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } }, { - "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.", - "name": "shard_size", + "description": "Values to include.\nAccepts regular expressions and partitions.", + "name": "include", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TermsInclude", + "namespace": "_types.aggregations" + } + } + }, + { + "description": "Only return values that are found in more than `min_doc_count` hits.", + "name": "min_doc_count", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -68212,242 +71315,102 @@ } }, { - "description": "Calculates the doc count error on per term basis.", - "name": "show_term_doc_count_error", + "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", + "name": "missing", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Missing", + "namespace": "_types.aggregations" } } }, { - "description": "The number of term buckets should be returned out of the overall terms list.", - "name": "size", + "name": "missing_order", "required": false, - "serverDefault": 10, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "MissingOrder", + "namespace": "_types.aggregations" } } }, { - "description": "The field from which to generate sets of terms.", - "name": "terms", - "required": true, + "name": "missing_bucket", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "MultiTermLookup", - "namespace": "_types.aggregations" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/aggregations/bucket.ts#L601-L641" - }, - { - "kind": "enum", - "members": [ - { - "description": "Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs.", - "name": "depth_first" }, { - "description": "Caches the set of documents that fall into the uppermost buckets for subsequent replay.", - "name": "breadth_first" - } - ], - "name": { - "name": "TermsAggregationCollectMode", - "namespace": "_types.aggregations" - }, - "specLocation": "_types/aggregations/bucket.ts#L1056-L1065" - }, - { - "kind": "interface", - "name": { - "name": "MultiTermLookup", - "namespace": "_types.aggregations" - }, - "properties": [ - { - "description": "A fields from which to retrieve terms.", - "name": "field", - "required": true, + "description": "Coerced unmapped fields into the specified type.", + "name": "value_type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", - "name": "missing", + "description": "Specifies the sort order of the buckets.\nDefaults to sorting by descending document count.", + "name": "order", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Missing", + "name": "AggregateOrder", "namespace": "_types.aggregations" } } - } - ], - "specLocation": "_types/aggregations/bucket.ts#L643-L653" - }, - { - "inherits": { - "type": { - "name": "BucketAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "NestedAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "The path to the field of type `nested`.", - "name": "path", + "name": "script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Script", "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/bucket.ts#L655-L660" - }, - { - "extDocId": "search-aggregations-pipeline-normalize-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-normalize-aggregation.html", - "inherits": { - "type": { - "name": "PipelineAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "NormalizeAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "The specific method to apply.", - "name": "method", + "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`.", + "name": "shard_min_doc_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NormalizeMethod", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L351-L359" - }, - { - "kind": "enum", - "members": [ - { - "description": "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.", - "name": "rescale_0_1" - }, - { - "description": "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.", - "name": "rescale_0_100" - }, - { - "description": "This method normalizes each value so that it represents a percentage of the total sum it attributes to.", - "name": "percent_of_sum" - }, - { - "description": "This method normalizes such that each value is normalized by how much it differs from the average.", - "name": "mean" - }, - { - "codegenName": "z_score", - "description": "This method normalizes such that each value represents how far it is from the mean relative to the standard deviation.", - "name": "z-score" }, { - "description": "This method normalizes such that each value is exponentiated and relative to the sum of the exponents of the original values.", - "name": "softmax" - } - ], - "name": { - "name": "NormalizeMethod", - "namespace": "_types.aggregations" - }, - "specLocation": "_types/aggregations/pipeline.ts#L361-L387" - }, - { - "inherits": { - "type": { - "name": "BucketAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "ParentAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ - { - "description": "The child type that should be selected.", - "name": "type", + "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.", + "name": "shard_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RelationName", + "name": "integer", "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/bucket.ts#L662-L667" - }, - { - "extDocId": "search-aggregations-metrics-percentile-rank-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html", - "inherits": { - "type": { - "name": "FormatMetricAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "PercentileRanksAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "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.", - "name": "keyed", + "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.", + "name": "show_term_doc_count_error", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -68457,70 +71420,52 @@ } }, { - "description": "An array of values for which to calculate the percentile ranks.", - "name": "values", - "required": false, - "type": { - "items": [ - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "description": "Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.", - "name": "hdr", + "description": "The number of buckets returned out of the overall terms list.", + "name": "size", "required": false, + "serverDefault": 10, "type": { "kind": "instance_of", "type": { - "name": "HdrMethod", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Sets parameters for the default TDigest algorithm used to calculate percentile ranks.", - "name": "tdigest", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TDigest", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/aggregations/metric.ts#L180-L202" + "specLocation": "_types/aggregations/bucket.ts#L963-L1031" }, { + "extDocId": "search-aggregations-bucket-time-series-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-time-series-aggregation.html", + "inherits": { + "type": { + "name": "BucketAggregationBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "HdrMethod", + "name": "TimeSeriesAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Specifies the resolution of values for the histogram in number of significant digits.", - "name": "number_of_significant_value_digits", + "description": "The maximum number of results to return.", + "name": "size", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { @@ -68528,50 +71473,55 @@ "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/metric.ts#L225-L230" - }, - { - "kind": "interface", - "name": { - "name": "TDigest", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.", - "name": "compression", + "description": "Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.", + "name": "keyed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "_types/aggregations/metric.ts#L232-L237" + "specLocation": "_types/aggregations/bucket.ts#L1033-L1046" }, { "inherits": { "type": { - "name": "FormatMetricAggregationBase", + "name": "MetricAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "PercentilesAggregation", + "name": "TopHitsAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "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.", - "name": "keyed", + "description": "Fields for which to return doc values.", + "name": "docvalue_fields", "required": false, - "serverDefault": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" + } + } + } + }, + { + "description": "If `true`, returns detailed information about score computation as part of a hit.", + "name": "explain", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -68581,147 +71531,135 @@ } }, { - "description": "The percentiles to calculate.", - "name": "percents", + "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", + "name": "fields", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "FieldAndFormat", + "namespace": "_types.query_dsl" } } } }, { - "description": "Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.", - "name": "hdr", + "description": "Starting document offset.", + "name": "from", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "HdrMethod", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Sets parameters for the default TDigest algorithm used to calculate percentiles.", - "name": "tdigest", + "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results.", + "name": "highlight", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TDigest", - "namespace": "_types.aggregations" + "name": "Highlight", + "namespace": "_global.search._types" } } - } - ], - "specLocation": "_types/aggregations/metric.ts#L204-L223" - }, - { - "extDocId": "search-aggregations-pipeline-percentiles-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-percentiles-bucket-aggregation.html", - "inherits": { - "type": { - "name": "PipelineAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "PercentilesBucketAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "The list of percentiles to calculate.", - "name": "percents", + "description": "Returns the result of one or more script evaluations for each hit.", + "name": "script_fields", "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "double", + "name": "ScriptField", "namespace": "_types" } } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L389-L397" - }, - { - "inherits": { - "type": { - "name": "BucketAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "RangeAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "The date field whose values are use to build ranges.", - "name": "field", + "description": "The maximum number of top matching hits to return per bucket.", + "name": "size", "required": false, + "serverDefault": 3, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "integer", "namespace": "_types" } } }, { - "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", - "name": "missing", + "description": "Sort order of the top matching hits.\nBy default, the hits are sorted by the score of the main query.", + "name": "sort", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Sort", "namespace": "_types" } } }, { - "description": "An array of ranges used to bucket documents.", - "name": "ranges", + "description": "Selects the fields of the source that are returned.", + "name": "_source", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationRange", - "namespace": "_types.aggregations" - } + "kind": "instance_of", + "type": { + "name": "SourceConfig", + "namespace": "_global.search._types" } } }, { - "name": "script", + "description": "Returns values for the specified stored fields (fields that use the `store` mapping option).", + "name": "stored_fields", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "If `true`, calculates and returns document scores, even if the scores are not used for sorting.", + "name": "track_scores", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.", - "name": "keyed", + "description": "If `true`, returns document version as part of a hit.", + "name": "version", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -68731,353 +71669,442 @@ } }, { - "name": "format", + "description": "If `true`, returns sequence number and primary term of the last modification of each hit.", + "name": "seq_no_primary_term", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L669-L689" + "specLocation": "_types/aggregations/metric.ts#L346-L406" }, { - "extDocId": "search-aggregations-bucket-rare-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-rare-terms-aggregation.html", "inherits": { "type": { - "name": "BucketAggregationBase", + "name": "Aggregation", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "RareTermsAggregation", + "name": "TTestAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Terms that should be excluded from the aggregation.", - "name": "exclude", + "description": "Test population A.", + "name": "a", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermsExclude", + "name": "TestPopulation", "namespace": "_types.aggregations" } } }, { - "description": "The field from which to return rare terms.", - "name": "field", + "description": "Test population B.", + "name": "b", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "TestPopulation", + "namespace": "_types.aggregations" } } }, { - "description": "Terms that should be included in the aggregation.", - "name": "include", + "description": "The type of test.", + "name": "type", "required": false, + "serverDefault": "heteroscedastic", "type": { "kind": "instance_of", "type": { - "name": "TermsInclude", + "name": "TTestType", "namespace": "_types.aggregations" } } - }, + } + ], + "specLocation": "_types/aggregations/metric.ts#L303-L317" + }, + { + "kind": "interface", + "name": { + "name": "TestPopulation", + "namespace": "_types.aggregations" + }, + "properties": [ { - "description": "The maximum number of documents a term should appear in.", - "name": "max_doc_count", - "required": false, - "serverDefault": 1, + "description": "The field to aggregate.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } }, { - "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", - "name": "missing", + "name": "script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Missing", - "namespace": "_types.aggregations" + "name": "Script", + "namespace": "_types" } } }, { - "description": "The precision of the internal CuckooFilters.\nSmaller precision leads to better approximation, but higher memory usage.", - "name": "precision", + "description": "A filter used to define a set of records to run unpaired t-test on.", + "name": "filter", "required": false, - "serverDefault": 0.001, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } + } + ], + "specLocation": "_types/aggregations/metric.ts#L319-L329" + }, + { + "kind": "enum", + "members": [ + { + "description": "Performs paired t-test.", + "name": "paired" }, { - "name": "value_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "description": "Performs two-sample equal variance test.", + "name": "homoscedastic" + }, + { + "description": "Performs two-sample unequal variance test.", + "name": "heteroscedastic" } ], - "specLocation": "_types/aggregations/bucket.ts#L706-L739" + "name": { + "name": "TTestType", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/metric.ts#L331-L344" }, { + "extDocId": "search-aggregations-metrics-top-metrics", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-metrics.html", "inherits": { "type": { - "name": "FormatMetricAggregationBase", + "name": "MetricAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "RateAggregation", + "name": "TopMetricsAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The interval used to calculate the rate.\nBy default, the interval of the `date_histogram` is used.", - "name": "unit", + "description": "The fields of the top document to return.", + "name": "metrics", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "TopMetricsValue", + "namespace": "_types.aggregations" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TopMetricsValue", + "namespace": "_types.aggregations" + } + } + } + ], + "kind": "union_of" + } + }, + { + "description": "The number of top documents from which to return metrics.", + "name": "size", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "CalendarInterval", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } }, { - "description": "How the rate is calculated.", - "name": "mode", + "description": "The sort order of the documents.", + "name": "sort", "required": false, - "serverDefault": "sum", "type": { "kind": "instance_of", "type": { - "name": "RateMode", - "namespace": "_types.aggregations" + "name": "Sort", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/metric.ts#L239-L250" + "specLocation": "_types/aggregations/metric.ts#L408-L425" }, { - "kind": "enum", - "members": [ - { - "description": "Calculates the sum of all values of the field.", - "name": "sum" - }, + "kind": "interface", + "name": { + "name": "TopMetricsValue", + "namespace": "_types.aggregations" + }, + "properties": [ { - "description": "Uses the number of values of the field.", - "name": "value_count" + "description": "A field to return as a metric.", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } } ], + "specLocation": "_types/aggregations/metric.ts#L427-L432" + }, + { + "inherits": { + "type": { + "name": "FormattableMetricAggregation", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", "name": { - "name": "RateMode", + "name": "ValueCountAggregation", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/metric.ts#L252-L261" + "properties": [], + "specLocation": "_types/aggregations/metric.ts#L434-L434" }, { "inherits": { "type": { - "name": "BucketAggregationBase", + "name": "MetricAggregationBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "ReverseNestedAggregation", + "name": "FormattableMetricAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "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.", - "name": "path", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L741-L747" + "specLocation": "_types/aggregations/metric.ts#L51-L53" }, { - "extDocId": "search-aggregations-random-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-random-sampler-aggregation.html", "inherits": { "type": { - "name": "BucketAggregationBase", + "name": "Aggregation", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "RandomSamplerAggregation", + "name": "WeightedAverageAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The probability that a document will be included in the aggregated data.\nMust be greater than 0, less than 0.5, or exactly 1.\nThe lower the probability, the fewer documents are matched.", - "name": "probability", - "required": true, + "description": "A numeric response formatter.", + "name": "format", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The seed to generate the random sampling of documents.\nWhen a seed is provided, the random subset of documents is the same between calls.", - "name": "seed", + "description": "Configuration for the field that provides the values.", + "name": "value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "WeightedAverageValue", + "namespace": "_types.aggregations" + } + } + }, + { + "name": "value_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ValueType", + "namespace": "_types.aggregations" + } + } + }, + { + "description": "Configuration for the field or script that provides the weights.", + "name": "weight", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "WeightedAverageValue", + "namespace": "_types.aggregations" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L749-L769" + "specLocation": "_types/aggregations/metric.ts#L449-L463" }, { - "extDocId": "search-aggregations-bucket-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-sampler-aggregation.html", - "inherits": { - "type": { - "name": "BucketAggregationBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "SamplerAggregation", + "name": "WeightedAverageValue", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Limits how many top-scoring documents are collected in the sample processed on each shard.", - "name": "shard_size", + "description": "The field from which to extract the values or weights.", + "name": "field", "required": false, - "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "A value or weight to use if the field is missing.", + "name": "missing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L771-L780" + "specLocation": "_types/aggregations/metric.ts#L465-L475" }, { - "inherits": { - "type": { - "name": "MetricAggregationBase", - "namespace": "_types.aggregations" - } - }, + "extDocId": "search-aggregations-bucket-variablewidthhistogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-variablewidthhistogram-aggregation.html", "kind": "interface", "name": { - "name": "ScriptedMetricAggregation", + "name": "VariableWidthHistogramAggregation", "namespace": "_types.aggregations" }, "properties": [ { - "description": "Runs once on each shard after document collection is complete.\nAllows the aggregation to consolidate the state returned from each shard.", - "name": "combine_script", + "description": "The name of the field.", + "name": "field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "Field", "namespace": "_types" } } }, { - "description": "Runs prior to any collection of documents.\nAllows the aggregation to set up any initial state.", - "name": "init_script", + "description": "The target number of buckets.", + "name": "buckets", "required": false, + "serverDefault": 10, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "integer", "namespace": "_types" } } }, { - "description": "Run once per document collected.\nIf no `combine_script` is specified, the resulting state needs to be stored in the `state` object.", - "name": "map_script", + "description": "The number of buckets that the coordinating node will request from each shard.\nDefaults to `buckets * 50`.", + "name": "shard_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "integer", "namespace": "_types" } } }, { - "description": "A global object with script parameters for `init`, `map` and `combine` scripts.\nIt is shared between the scripts.", - "name": "params", + "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)`.", + "name": "initial_buffer", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "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.", - "name": "reduce_script", + "name": "script", "required": false, "type": { "kind": "instance_of", @@ -69088,748 +72115,913 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L263-L289" + "specLocation": "_types/aggregations/bucket.ts#L1091-L1115" }, { - "extDocId": "search-aggregations-pipeline-serialdiff-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-serialdiff-aggregation.html", - "inherits": { - "type": { - "name": "PipelineAggregationBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "SerialDifferencingAggregation", - "namespace": "_types.aggregations" + "name": "KnnSearch", + "namespace": "_types" }, "properties": [ { - "description": "The historical bucket to subtract from the current value.\nMust be a positive, non-zero integer.", - "name": "lag", - "required": false, + "description": "The name of the vector field to search against", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Field", "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/pipeline.ts#L399-L408" - }, - { - "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", - "inherits": { - "type": { - "name": "BucketAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "SignificantTermsAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.", - "name": "background_filter", + "description": "The query vector", + "name": "query_vector", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "QueryVector", + "namespace": "_types" } } }, { - "description": "Use Chi square, as described in \"Information Retrieval\", Manning et al., Chapter 13.5.2, as the significance score.", - "name": "chi_square", + "description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.", + "name": "query_vector_builder", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ChiSquareHeuristic", - "namespace": "_types.aggregations" + "name": "QueryVectorBuilder", + "namespace": "_types" } } }, { - "description": "Terms to exclude.", - "name": "exclude", + "description": "The final number of nearest neighbors to return as top hits", + "name": "k", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermsExclude", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } }, { - "description": "Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.", - "name": "execution_hint", + "description": "The number of nearest neighbor candidates to consider per shard", + "name": "num_candidates", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermsAggregationExecutionHint", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } }, { - "description": "The field from which to return significant terms.", - "name": "field", + "description": "Boost value to apply to kNN scores", + "name": "boost", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "float", "namespace": "_types" } } }, { - "description": "Use Google normalized distance as described in \"The Google Similarity Distance\", Cilibrasi and Vitanyi, 2007, as the significance score.", - "name": "gnd", + "description": "Filters for the kNN search query", + "name": "filter", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "GoogleNormalizedDistanceHeuristic", - "namespace": "_types.aggregations" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + } + ], + "kind": "union_of" } }, { - "description": "Terms to include.", - "name": "include", + "description": "The minimum similarity for a vector to be considered a match", + "name": "similarity", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermsInclude", - "namespace": "_types.aggregations" + "name": "float", + "namespace": "_types" } } }, { - "description": "Use JLH score as the significance score.", - "name": "jlh", + "description": "If defined, each search hit will contain inner hits.", + "docId": "knn-inner-hits", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#nested-knn-search-inner-hits", + "name": "inner_hits", "required": false, "type": { "kind": "instance_of", "type": { - "name": "EmptyObject", - "namespace": "_types" + "name": "InnerHits", + "namespace": "_global.search._types" } } }, { - "description": "Only return terms that are found in more than `min_doc_count` hits.", - "name": "min_doc_count", + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "since": "8.18.0", + "stability": "experimental" + } + }, + "description": "Apply oversampling and rescoring to quantized vectors *", + "name": "rescore_vector", "required": false, - "serverDefault": 3, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "RescoreVector", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/Knn.ts#L35-L62" + }, + { + "kind": "interface", + "name": { + "name": "Rescore", + "namespace": "_global.search._types" + }, + "properties": [ { - "description": "Use mutual information as described in \"Information Retrieval\", Manning et al., Chapter 13.5.1, as the significance score.", - "name": "mutual_information", + "containerProperty": true, + "name": "window_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MutualInformationHeuristic", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } }, { - "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.", - "name": "percentage", + "name": "query", "required": false, "type": { "kind": "instance_of", "type": { - "name": "PercentageScoreHeuristic", - "namespace": "_types.aggregations" + "name": "RescoreQuery", + "namespace": "_global.search._types" } } }, { - "description": "Customized score, implemented via a script.", - "name": "script_heuristic", + "name": "learning_to_rank", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ScriptedHeuristic", - "namespace": "_types.aggregations" + "name": "LearningToRank", + "namespace": "_global.search._types" } } - }, + } + ], + "specLocation": "_global/search/_types/rescoring.ts#L25-L38", + "variants": { + "kind": "container", + "nonExhaustive": true + } + }, + { + "kind": "interface", + "name": { + "name": "RescoreQuery", + "namespace": "_global.search._types" + }, + "properties": [ { - "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`.", - "name": "shard_min_doc_count", - "required": false, + "codegenName": "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.", + "name": "rescore_query", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "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.", - "name": "shard_size", + "description": "Relative importance of the original query versus the rescore query.", + "name": "query_weight", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "description": "The number of buckets returned out of the overall terms list.", - "name": "size", + "description": "Relative importance of the rescore query versus the original query.", + "name": "rescore_query_weight", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/bucket.ts#L817-L884" - }, - { - "kind": "interface", - "name": { - "name": "ChiSquareHeuristic", - "namespace": "_types.aggregations" - }, - "properties": [ - { - "description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.", - "name": "background_is_superset", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } }, { - "description": "Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset.", - "name": "include_negatives", - "required": true, + "description": "Determines how scores are combined.", + "name": "score_mode", + "required": false, + "serverDefault": "total", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ScoreMode", + "namespace": "_global.search._types" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L782-L791" + "specLocation": "_global/search/_types/rescoring.ts#L40-L62" }, { "kind": "enum", "members": [ { - "name": "map" + "description": "Average the original score and the rescore query score.", + "name": "avg" }, { - "name": "global_ordinals" + "description": "Take the max of original score and the rescore query score.", + "name": "max" }, { - "name": "global_ordinals_hash" + "description": "Take the min of the original score and the rescore query score.", + "name": "min" }, { - "name": "global_ordinals_low_cardinality" + "description": "Multiply the original score by the rescore query score.\nUseful for `function` query rescores.", + "name": "multiply" + }, + { + "description": "Add the original score and the rescore query score.", + "name": "total" } ], "name": { - "name": "TermsAggregationExecutionHint", - "namespace": "_types.aggregations" + "name": "ScoreMode", + "namespace": "_global.search._types" }, - "specLocation": "_types/aggregations/bucket.ts#L1067-L1072" + "specLocation": "_global/search/_types/rescoring.ts#L64-L86" }, { "kind": "interface", "name": { - "name": "GoogleNormalizedDistanceHeuristic", - "namespace": "_types.aggregations" + "name": "LearningToRank", + "namespace": "_global.search._types" }, "properties": [ { - "description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.", - "name": "background_is_superset", - "required": false, + "description": "The unique identifier of the trained model uploaded to Elasticsearch", + "name": "model_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } + }, + { + "description": "Named parameters to be passed to the query templates used for feature", + "name": "params", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } } ], - "specLocation": "_types/aggregations/bucket.ts#L793-L798" + "specLocation": "_global/search/_types/rescoring.ts#L88-L97" }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "MutualInformationHeuristic", - "namespace": "_types.aggregations" + "name": "SortResults", + "namespace": "_types" }, - "properties": [ - { - "description": "Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.", - "name": "background_is_superset", - "required": false, + "specLocation": "_types/sort.ts#L106-L106", + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", "type": { + "name": "FieldValue", + "namespace": "_types" + } + } + } + }, + { + "codegenNames": [ + "enabled", + "count" + ], + "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.", + "kind": "type_alias", + "name": { + "name": "TrackHits", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/hits.ts#L143-L151", + "type": { + "items": [ + { "kind": "instance_of", "type": { "name": "boolean", "namespace": "_builtins" } - } - }, - { - "description": "Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset.", - "name": "include_negatives", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/bucket.ts#L800-L809" + ], + "kind": "union_of" + } }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "PercentageScoreHeuristic", - "namespace": "_types.aggregations" + "name": "RuntimeFields", + "namespace": "_types.mapping" }, - "properties": [], - "specLocation": "_types/aggregations/bucket.ts#L811-L811" + "specLocation": "_types/mapping/RuntimeFields.ts#L24-L24", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "RuntimeField", + "namespace": "_types.mapping" + } + } + } }, { "kind": "interface", "name": { - "name": "ScriptedHeuristic", - "namespace": "_types.aggregations" + "name": "RuntimeField", + "namespace": "_types.mapping" }, "properties": [ { - "name": "script", - "required": true, + "description": "For type `composite`", + "name": "fields", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "CompositeSubField", + "namespace": "_types.mapping" + } } } - } - ], - "specLocation": "_types/aggregations/bucket.ts#L813-L815" - }, - { - "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", - "inherits": { - "type": { - "name": "BucketAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "SignificantTextAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.", - "name": "background_filter", + "description": "For type `lookup`", + "name": "fetch_fields", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RuntimeFieldFetchFields", + "namespace": "_types.mapping" + } } } }, { - "description": "Use Chi square, as described in \"Information Retrieval\", Manning et al., Chapter 13.5.2, as the significance score.", - "name": "chi_square", + "description": "A custom format for `date` type runtime fields.", + "docId": "mapping-date-format", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ChiSquareHeuristic", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Values to exclude.", - "name": "exclude", + "description": "For type `lookup`", + "name": "input_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermsExclude", - "namespace": "_types.aggregations" + "name": "Field", + "namespace": "_types" } } }, { - "description": "Determines whether the aggregation will use field values directly or global ordinals.", - "name": "execution_hint", + "description": "For type `lookup`", + "name": "target_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermsAggregationExecutionHint", - "namespace": "_types.aggregations" + "name": "Field", + "namespace": "_types" } } }, { - "description": "The field from which to return significant text.", - "name": "field", + "description": "For type `lookup`", + "name": "target_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "IndexName", "namespace": "_types" } } }, { - "description": "Whether to out duplicate text to deal with noisy data.", - "name": "filter_duplicate_text", + "description": "Painless script executed at query time.", + "name": "script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Script", + "namespace": "_types" } } }, { - "description": "Use Google normalized distance as described in \"The Google Similarity Distance\", Cilibrasi and Vitanyi, 2007, as the significance score.", - "name": "gnd", - "required": false, + "description": "Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`.", + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "GoogleNormalizedDistanceHeuristic", - "namespace": "_types.aggregations" + "name": "RuntimeFieldType", + "namespace": "_types.mapping" + } + } + } + ], + "specLocation": "_types/mapping/RuntimeFields.ts#L26-L50" + }, + { + "kind": "interface", + "name": { + "name": "CompositeSubField", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "RuntimeFieldType", + "namespace": "_types.mapping" } } + } + ], + "specLocation": "_types/mapping/RuntimeFields.ts#L52-L54" + }, + { + "kind": "enum", + "members": [ + { + "name": "boolean" }, { - "description": "Values to include.", - "name": "include", - "required": false, + "name": "composite" + }, + { + "name": "date" + }, + { + "name": "double" + }, + { + "name": "geo_point" + }, + { + "name": "geo_shape" + }, + { + "name": "ip" + }, + { + "name": "keyword" + }, + { + "name": "long" + }, + { + "name": "lookup" + } + ], + "name": { + "name": "RuntimeFieldType", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/RuntimeFields.ts#L62-L73" + }, + { + "kind": "interface", + "name": { + "name": "RuntimeFieldFetchFields", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TermsInclude", - "namespace": "_types.aggregations" + "name": "Field", + "namespace": "_types" } } }, { - "description": "Use JLH score as the significance score.", - "name": "jlh", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "EmptyObject", + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "shortcutProperty": "field", + "specLocation": "_types/mapping/RuntimeFields.ts#L56-L60" + }, + { + "kind": "interface", + "name": { + "name": "PointInTimeReference", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", "namespace": "_types" } } }, { - "description": "Only return values that are found in more than `min_doc_count` hits.", - "name": "min_doc_count", + "name": "keep_alive", "required": false, - "serverDefault": 3, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Duration", "namespace": "_types" } } - }, + } + ], + "specLocation": "_global/search/_types/PointInTimeReference.ts#L23-L26" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ { - "description": "Use mutual information as described in \"Information Retrieval\", Manning et al., Chapter 13.5.1, as the significance score.", - "name": "mutual_information", + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "FieldSuggester", + "namespace": "_global.search._types" + } + } + ], + "meta": { + "description": "The named suggesters", + "fieldname": "suggesters" + }, + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], + "kind": "interface", + "name": { + "name": "Suggester", + "namespace": "_global.search._types" + }, + "properties": [ + { + "description": "Global suggest text, to avoid repetition when the same text is used in several suggesters", + "name": "text", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MutualInformationHeuristic", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_global/search/_types/suggester.ts#L101-L107" + }, + { + "kind": "interface", + "name": { + "name": "FieldSuggester", + "namespace": "_global.search._types" + }, + "properties": [ { - "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.", - "name": "percentage", + "description": "Provides auto-complete/search-as-you-type functionality.", + "name": "completion", "required": false, "type": { "kind": "instance_of", "type": { - "name": "PercentageScoreHeuristic", - "namespace": "_types.aggregations" + "name": "CompletionSuggester", + "namespace": "_global.search._types" } } }, { - "description": "Customized score, implemented via a script.", - "name": "script_heuristic", + "description": "Provides access to word alternatives on a per token basis within a certain string distance.", + "name": "phrase", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ScriptedHeuristic", - "namespace": "_types.aggregations" + "name": "PhraseSuggester", + "namespace": "_global.search._types" } } }, { - "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`.", - "name": "shard_min_doc_count", + "description": "Suggests terms based on edit distance.", + "name": "term", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "TermSuggester", + "namespace": "_global.search._types" } } }, { - "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.", - "name": "shard_size", + "containerProperty": true, + "description": "Prefix used to search for suggestions.", + "name": "prefix", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The number of buckets returned out of the overall terms list.", - "name": "size", + "containerProperty": true, + "description": "A prefix expressed as a regular expression.", + "name": "regex", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Overrides the JSON `_source` fields from which text will be analyzed.", - "name": "source_fields", + "containerProperty": true, + "description": "The text to use as input for the suggester.\nNeeds to be set globally or per suggestion.", + "name": "text", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L886-L961" - }, - { - "inherits": { - "type": { - "name": "FormatMetricAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "StatsAggregation", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/metric.ts#L291-L291" - }, - { - "inherits": { - "type": { - "name": "PipelineAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "StatsBucketAggregation", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L410-L410" + "specLocation": "_global/search/_types/suggester.ts#L109-L142", + "variants": { + "kind": "container", + "nonExhaustive": true + } }, { "inherits": { "type": { - "name": "MetricAggregationBase", - "namespace": "_types.aggregations" + "name": "SuggesterBase", + "namespace": "_global.search._types" } }, "kind": "interface", "name": { - "name": "StringStatsAggregation", - "namespace": "_types.aggregations" + "name": "CompletionSuggester", + "namespace": "_global.search._types" }, "properties": [ { - "description": "Shows the probability distribution for all characters.", - "name": "show_distribution", + "description": "A value, geo point object, or a geo hash string to filter or boost the suggestion on.", + "name": "contexts", "required": false, - "serverDefault": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "CompletionContext", + "namespace": "_global.search._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CompletionContext", + "namespace": "_global.search._types" + } + } + } + ], + "kind": "union_of" } } - } - ], - "specLocation": "_types/aggregations/metric.ts#L293-L299" - }, - { - "inherits": { - "type": { - "name": "FormatMetricAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "SumAggregation", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/metric.ts#L301-L301" - }, - { - "extDocId": "search-aggregations-pipeline-sum-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-sum-bucket-aggregation.html", - "inherits": { - "type": { - "name": "PipelineAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "SumBucketAggregation", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L412-L415" - }, - { - "extDocId": "search-aggregations-bucket-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html", - "inherits": { - "type": { - "name": "BucketAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "TermsAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "Determines how child aggregations should be calculated: breadth-first or depth-first.", - "name": "collect_mode", + "description": "Enables fuzziness, meaning you can have a typo in your search and still get results back.", + "name": "fuzzy", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermsAggregationCollectMode", - "namespace": "_types.aggregations" + "name": "SuggestFuzziness", + "namespace": "_global.search._types" } } }, { - "description": "Values to exclude.\nAccepts regular expressions and partitions.", - "name": "exclude", + "description": "A regex query that expresses a prefix as a regular expression.", + "name": "regex", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermsExclude", - "namespace": "_types.aggregations" + "name": "RegexOptions", + "namespace": "_global.search._types" } } }, { - "description": "Determines whether the aggregation will use field values directly or global ordinals.", - "name": "execution_hint", + "description": "Whether duplicate suggestions should be filtered out.", + "name": "skip_duplicates", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "TermsAggregationExecutionHint", - "namespace": "_types.aggregations" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_global/search/_types/suggester.ts#L163-L181" + }, + { + "kind": "interface", + "name": { + "name": "SuggesterBase", + "namespace": "_global.search._types" + }, + "properties": [ { - "description": "The field from which to return terms.", + "description": "The field to fetch the candidate suggestions from.\nNeeds to be set globally or per suggestion.", "name": "field", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -69839,22 +73031,21 @@ } }, { - "description": "Values to include.\nAccepts regular expressions and partitions.", - "name": "include", + "description": "The analyzer to analyze the suggest text with.\nDefaults to the search analyzer of the suggest field.", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermsInclude", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Only return values that are found in more than `min_doc_count` hits.", - "name": "min_doc_count", + "description": "The maximum corrections to be returned per suggest text token.", + "name": "size", "required": false, - "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -69862,92 +73053,147 @@ "namespace": "_types" } } - }, + } + ], + "specLocation": "_global/search/_types/suggester.ts#L144-L159" + }, + { + "kind": "interface", + "name": { + "name": "CompletionContext", + "namespace": "_global.search._types" + }, + "properties": [ { - "description": "The value to apply to documents that do not have a value.\nBy default, documents without a value are ignored.", - "name": "missing", + "description": "The factor by which the score of the suggestion should be boosted.\nThe score is computed by multiplying the boost with the suggestion weight.", + "name": "boost", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "Missing", - "namespace": "_types.aggregations" + "name": "double", + "namespace": "_types" } } }, { - "name": "missing_order", - "required": false, + "description": "The value of the category to filter/boost on.", + "name": "context", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MissingOrder", - "namespace": "_types.aggregations" + "name": "Context", + "namespace": "_global.search._types" } } }, { - "name": "missing_bucket", + "description": "An array of precision values at which neighboring geohashes should be taken into account.\nPrecision value can be a distance value (`5m`, `10km`, etc.) or a raw geohash precision (`1`..`12`).\nDefaults to generating neighbors for index time precision level.", + "name": "neighbours", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "GeoHashPrecision", + "namespace": "_types" + } } } }, { - "description": "Coerced unmapped fields into the specified type.", - "name": "value_type", + "description": "The precision of the geohash to encode the query geo point.\nCan be specified as a distance value (`5m`, `10km`, etc.), or as a raw geohash precision (`1`..`12`).\nDefaults to index time precision level.", + "name": "precision", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "GeoHashPrecision", + "namespace": "_types" } } }, { - "description": "Specifies the sort order of the buckets.\nDefaults to sorting by descending document count.", - "name": "order", + "description": "Whether the category value should be treated as a prefix or not.", + "name": "prefix", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "AggregateOrder", - "namespace": "_types.aggregations" + "name": "boolean", + "namespace": "_builtins" } } - }, - { - "name": "script", - "required": false, - "type": { + } + ], + "shortcutProperty": "context", + "specLocation": "_global/search/_types/suggester.ts#L235-L264" + }, + { + "codegenNames": [ + "category", + "location" + ], + "description": "Text or location that we want similar documents for or a lookup to a document's field for the text.", + "docId": "document-input-parameters", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", + "kind": "type_alias", + "name": { + "name": "Context", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/suggester.ts#L228-L233", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "Script", + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GeoLocation", "namespace": "_types" } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "interface", + "name": { + "name": "SuggestFuzziness", + "namespace": "_global.search._types" + }, + "properties": [ { - "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`.", - "name": "shard_min_doc_count", + "description": "The fuzziness factor.", + "docId": "fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "name": "fuzziness", "required": false, + "serverDefault": "AUTO", "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Fuzziness", "namespace": "_types" } } }, { - "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.", - "name": "shard_size", + "description": "Minimum length of the input before fuzzy suggestions are returned.", + "name": "min_length", "required": false, + "serverDefault": 3, "type": { "kind": "instance_of", "type": { @@ -69957,148 +73203,164 @@ } }, { - "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.", - "name": "show_term_doc_count_error", + "description": "Minimum length of the input, which is not checked for fuzzy alternatives.", + "name": "prefix_length", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "description": "The number of buckets returned out of the overall terms list.", - "name": "size", + "description": "If set to `true`, transpositions are counted as one change instead of two.", + "name": "transpositions", "required": false, - "serverDefault": 10, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "format", + "description": "If `true`, all measurements (like fuzzy edit distance, transpositions, and lengths) are measured in Unicode code points instead of in bytes.\nThis is slightly slower than raw bytes.", + "name": "unicode_aware", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L963-L1031" + "specLocation": "_global/search/_types/suggester.ts#L196-L224" }, { - "extDocId": "search-aggregations-bucket-time-series-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-time-series-aggregation.html", - "inherits": { - "type": { - "name": "BucketAggregationBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "TimeSeriesAggregation", - "namespace": "_types.aggregations" + "name": "RegexOptions", + "namespace": "_global.search._types" }, "properties": [ { - "description": "The maximum number of results to return.", - "name": "size", + "description": "Optional operators for the regular expression.", + "docId": "regexp-syntax", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", + "name": "flags", "required": false, - "serverDefault": 10000, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.", - "name": "keyed", + "description": "Maximum number of automaton states required for the query.", + "name": "max_determinized_states", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/bucket.ts#L1033-L1046" + "specLocation": "_global/search/_types/suggester.ts#L183-L194" }, { "inherits": { "type": { - "name": "MetricAggregationBase", - "namespace": "_types.aggregations" + "name": "SuggesterBase", + "namespace": "_global.search._types" } }, "kind": "interface", "name": { - "name": "TopHitsAggregation", - "namespace": "_types.aggregations" + "name": "PhraseSuggester", + "namespace": "_global.search._types" }, "properties": [ { - "description": "Fields for which to return doc values.", - "name": "docvalue_fields", + "description": "Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index.", + "name": "collate", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldAndFormat", - "namespace": "_types.query_dsl" - } + "kind": "instance_of", + "type": { + "name": "PhraseSuggestCollate", + "namespace": "_global.search._types" } } }, { - "description": "If `true`, returns detailed information about score computation as part of a hit.", - "name": "explain", + "description": "Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates.\nOnly candidates that score higher than the threshold will be included in the result.", + "name": "confidence", "required": false, - "serverDefault": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", - "name": "fields", + "description": "A list of candidate generators that produce a list of possible terms per term in the given text.", + "name": "direct_generator", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "FieldAndFormat", - "namespace": "_types.query_dsl" + "name": "DirectGenerator", + "namespace": "_global.search._types" } } } }, { - "description": "Starting document offset.", - "name": "from", + "name": "force_unigrams", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Sets max size of the n-grams (shingles) in the field.\nIf the field doesn’t contain n-grams (shingles), this should be omitted or set to `1`.\nIf the field uses a shingle filter, the `gram_size` is set to the `max_shingle_size` if not explicitly set.", + "name": "gram_size", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -70108,192 +73370,202 @@ } }, { - "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results.", + "description": "Sets up suggestion highlighting.\nIf not provided, no highlighted field is returned.", "name": "highlight", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Highlight", + "name": "PhraseSuggestHighlight", "namespace": "_global.search._types" } } }, { - "description": "Returns the result of one or more script evaluations for each hit.", - "name": "script_fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ScriptField", - "namespace": "_types" - } - } - } - }, - { - "description": "The maximum number of top matching hits to return per bucket.", - "name": "size", + "description": "The maximum percentage of the terms considered to be misspellings in order to form a correction.\nThis method accepts a float value in the range `[0..1)` as a fraction of the actual query terms or a number `>=1` as an absolute number of query terms.", + "name": "max_errors", "required": false, - "serverDefault": 3, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "description": "Sort order of the top matching hits.\nBy default, the hits are sorted by the score of the main query.", - "name": "sort", + "description": "The likelihood of a term being misspelled even if the term exists in the dictionary.", + "name": "real_word_error_likelihood", "required": false, + "serverDefault": 0.95, "type": { "kind": "instance_of", "type": { - "name": "Sort", + "name": "double", "namespace": "_types" } } }, { - "description": "Selects the fields of the source that are returned.", - "name": "_source", + "description": "The separator that is used to separate terms in the bigram field.\nIf not set, the whitespace character is used as a separator.", + "name": "separator", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SourceConfig", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Returns values for the specified stored fields (fields that use the `store` mapping option).", - "name": "stored_fields", + "description": "Sets the maximum number of suggested terms to be retrieved from each individual shard.", + "name": "shard_size", "required": false, + "serverDefault": 5, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "integer", "namespace": "_types" } } }, { - "description": "If `true`, calculates and returns document scores, even if the scores are not used for sorting.", - "name": "track_scores", + "description": "The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index).\nThe default model is Stupid Backoff.", + "name": "smoothing", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "SmoothingModelContainer", + "namespace": "_global.search._types" } } }, { - "description": "If `true`, returns document version as part of a hit.", - "name": "version", + "description": "The text/query to provide suggestions for.", + "name": "text", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "If `true`, returns sequence number and primary term of the last modification of each hit.", - "name": "seq_no_primary_term", + "name": "token_limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/metric.ts#L346-L406" + "specLocation": "_global/search/_types/suggester.ts#L359-L417" }, { - "inherits": { - "type": { - "name": "Aggregation", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "TTestAggregation", - "namespace": "_types.aggregations" + "name": "PhraseSuggestCollate", + "namespace": "_global.search._types" }, "properties": [ { - "description": "Test population A.", - "name": "a", + "description": "Parameters to use if the query is templated.", + "name": "params", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "description": "Returns all suggestions with an extra `collate_match` option indicating whether the generated phrase matched any document.", + "name": "prune", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TestPopulation", - "namespace": "_types.aggregations" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Test population B.", - "name": "b", + "description": "A collate query that is run once for every suggestion.", + "name": "query", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "PhraseSuggestCollateQuery", + "namespace": "_global.search._types" + } + } + } + ], + "specLocation": "_global/search/_types/suggester.ts#L333-L346" + }, + { + "kind": "interface", + "name": { + "name": "PhraseSuggestCollateQuery", + "namespace": "_global.search._types" + }, + "properties": [ + { + "description": "The search template ID.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TestPopulation", - "namespace": "_types.aggregations" + "name": "Id", + "namespace": "_types" } } }, { - "description": "The type of test.", - "name": "type", + "description": "The query source.", + "name": "source", "required": false, - "serverDefault": "heteroscedastic", "type": { "kind": "instance_of", "type": { - "name": "TTestType", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/aggregations/metric.ts#L303-L317" + "specLocation": "_global/search/_types/suggester.ts#L348-L357" }, { "kind": "interface", "name": { - "name": "TestPopulation", - "namespace": "_types.aggregations" + "name": "DirectGenerator", + "namespace": "_global.search._types" }, "properties": [ { - "description": "The field to aggregate.", + "description": "The field to fetch the candidate suggestions from.\nNeeds to be set globally or per suggestion.", "name": "field", "required": true, "type": { @@ -70305,98 +73577,97 @@ } }, { - "name": "script", + "description": "The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.\nCan only be `1` or `2`.", + "name": "max_edits", "required": false, + "serverDefault": 2, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "integer", "namespace": "_types" } } }, { - "description": "A filter used to define a set of records to run unpaired t-test on.", - "name": "filter", + "description": "A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.\nCan improve accuracy at the cost of performance.", + "name": "max_inspections", "required": false, + "serverDefault": 5, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "float", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/metric.ts#L319-L329" - }, - { - "kind": "enum", - "members": [ + }, { - "description": "Performs paired t-test.", - "name": "paired" + "description": "The maximum threshold in number of documents in which a suggest text token can exist in order to be included.\nThis can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked.\nCan be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.\nIf a value higher than 1 is specified, then fractional can not be specified.", + "name": "max_term_freq", + "required": false, + "serverDefault": 0.01, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } }, { - "description": "Performs two-sample equal variance test.", - "name": "homoscedastic" + "description": "The minimal threshold in number of documents a suggestion should appear in.\nThis can improve quality by only suggesting high frequency terms.\nCan be specified as an absolute number or as a relative percentage of number of documents.\nIf a value higher than 1 is specified, the number cannot be fractional.", + "name": "min_doc_freq", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } }, { - "description": "Performs two-sample unequal variance test.", - "name": "heteroscedastic" - } - ], - "name": { - "name": "TTestType", - "namespace": "_types.aggregations" - }, - "specLocation": "_types/aggregations/metric.ts#L331-L344" - }, - { - "extDocId": "search-aggregations-metrics-top-metrics", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-metrics.html", - "inherits": { - "type": { - "name": "MetricAggregationBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "TopMetricsAggregation", - "namespace": "_types.aggregations" - }, - "properties": [ + "description": "The minimum length a suggest text term must have in order to be included.", + "name": "min_word_length", + "required": false, + "serverDefault": 4, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, { - "description": "The fields of the top document to return.", - "name": "metrics", + "description": "A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer.", + "name": "post_filter", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "TopMetricsValue", - "namespace": "_types.aggregations" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TopMetricsValue", - "namespace": "_types.aggregations" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "description": "The number of top documents from which to return metrics.", - "name": "size", + "description": "A filter (analyzer) that is applied to each of the tokens passed to this candidate generator.\nThis filter is applied to the original token before candidates are generated.", + "name": "pre_filter", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The number of minimal prefix characters that must match in order be a candidate suggestions.\nIncreasing this number improves spellcheck performance.", + "name": "prefix_length", "required": false, "serverDefault": 1, "type": { @@ -70408,73 +73679,78 @@ } }, { - "description": "The sort order of the documents.", - "name": "sort", + "description": "The maximum corrections to be returned per suggest text token.", + "name": "size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Sort", + "name": "integer", "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/metric.ts#L408-L425" - }, - { - "kind": "interface", - "name": { - "name": "TopMetricsValue", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "description": "A field to return as a metric.", - "name": "field", - "required": true, + "description": "Controls what suggestions are included on the suggestions generated on each shard.", + "name": "suggest_mode", + "required": false, + "serverDefault": "missing", "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "SuggestMode", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/metric.ts#L427-L432" + "specLocation": "_global/search/_types/suggester.ts#L268-L331" }, { - "inherits": { - "type": { - "name": "FormattableMetricAggregation", - "namespace": "_types.aggregations" + "kind": "enum", + "members": [ + { + "description": "Only generate suggestions for terms that are not in the shard.", + "name": "missing" + }, + { + "description": "Only suggest terms that occur in more docs on the shard than the original term.", + "name": "popular" + }, + { + "description": "Suggest any matching suggestions based on terms in the suggest text.", + "name": "always" } - }, - "kind": "interface", + ], "name": { - "name": "ValueCountAggregation", - "namespace": "_types.aggregations" + "name": "SuggestMode", + "namespace": "_types" }, - "properties": [], - "specLocation": "_types/aggregations/metric.ts#L434-L434" + "specLocation": "_types/common.ts#L279-L292" }, { - "inherits": { - "type": { - "name": "MetricAggregationBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "FormattableMetricAggregation", - "namespace": "_types.aggregations" + "name": "PhraseSuggestHighlight", + "namespace": "_global.search._types" }, "properties": [ { - "name": "format", - "required": false, + "description": "Use in conjunction with `pre_tag` to define the HTML tags to use for the highlighted text.", + "name": "post_tag", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Use in conjunction with `post_tag` to define the HTML tags to use for the highlighted text.", + "name": "pre_tag", + "required": true, "type": { "kind": "instance_of", "type": { @@ -70484,94 +73760,100 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L51-L53" + "specLocation": "_global/search/_types/suggester.ts#L419-L428" }, { - "inherits": { - "type": { - "name": "Aggregation", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "WeightedAverageAggregation", - "namespace": "_types.aggregations" + "name": "SmoothingModelContainer", + "namespace": "_global.search._types" }, "properties": [ { - "description": "A numeric response formatter.", - "name": "format", + "description": "A smoothing model that uses an additive smoothing where a constant (typically `1.0` or smaller) is added to all counts to balance weights.", + "name": "laplace", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "LaplaceSmoothingModel", + "namespace": "_global.search._types" } } }, { - "description": "Configuration for the field that provides the values.", - "name": "value", + "description": "A smoothing model that takes the weighted mean of the unigrams, bigrams, and trigrams based on user supplied weights (lambdas).", + "name": "linear_interpolation", "required": false, "type": { "kind": "instance_of", "type": { - "name": "WeightedAverageValue", - "namespace": "_types.aggregations" + "name": "LinearInterpolationSmoothingModel", + "namespace": "_global.search._types" } } }, { - "name": "value_type", + "description": "A simple backoff model that backs off to lower order n-gram models if the higher order count is `0` and discounts the lower order n-gram model by a constant factor.", + "name": "stupid_backoff", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ValueType", - "namespace": "_types.aggregations" + "name": "StupidBackoffSmoothingModel", + "namespace": "_global.search._types" } } - }, + } + ], + "specLocation": "_global/search/_types/suggester.ts#L445-L461", + "variants": { + "kind": "container" + } + }, + { + "kind": "interface", + "name": { + "name": "LaplaceSmoothingModel", + "namespace": "_global.search._types" + }, + "properties": [ { - "description": "Configuration for the field or script that provides the weights.", - "name": "weight", - "required": false, + "description": "A constant that is added to all counts to balance weights.", + "name": "alpha", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "WeightedAverageValue", - "namespace": "_types.aggregations" + "name": "double", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/metric.ts#L449-L463" + "specLocation": "_global/search/_types/suggester.ts#L430-L435" }, { "kind": "interface", "name": { - "name": "WeightedAverageValue", - "namespace": "_types.aggregations" + "name": "LinearInterpolationSmoothingModel", + "namespace": "_global.search._types" }, "properties": [ { - "description": "The field from which to extract the values or weights.", - "name": "field", - "required": false, + "name": "bigram_lambda", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "double", "namespace": "_types" } } }, { - "description": "A value or weight to use if the field is missing.", - "name": "missing", - "required": false, + "name": "trigram_lambda", + "required": true, "type": { "kind": "instance_of", "type": { @@ -70581,69 +73863,70 @@ } }, { - "name": "script", - "required": false, + "name": "unigram_lambda", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "double", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/metric.ts#L465-L475" + "specLocation": "_global/search/_types/suggester.ts#L437-L441" }, { - "extDocId": "search-aggregations-bucket-variablewidthhistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-variablewidthhistogram-aggregation.html", "kind": "interface", "name": { - "name": "VariableWidthHistogramAggregation", - "namespace": "_types.aggregations" + "name": "StupidBackoffSmoothingModel", + "namespace": "_global.search._types" }, "properties": [ { - "description": "The name of the field.", - "name": "field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "The target number of buckets.", - "name": "buckets", - "required": false, - "serverDefault": 10, + "description": "A constant factor that the lower order n-gram model is discounted by.", + "name": "discount", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } - }, + } + ], + "specLocation": "_global/search/_types/suggester.ts#L463-L468" + }, + { + "inherits": { + "type": { + "name": "SuggesterBase", + "namespace": "_global.search._types" + } + }, + "kind": "interface", + "name": { + "name": "TermSuggester", + "namespace": "_global.search._types" + }, + "properties": [ { - "description": "The number of buckets that the coordinating node will request from each shard.\nDefaults to `buckets * 50`.", - "name": "shard_size", + "name": "lowercase_terms", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "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)`.", - "name": "initial_buffer", + "description": "The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.\nCan only be `1` or `2`.", + "name": "max_edits", "required": false, + "serverDefault": 2, "type": { "kind": "instance_of", "type": { @@ -70653,66 +73936,62 @@ } }, { - "name": "script", + "description": "A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.\nCan improve accuracy at the cost of performance.", + "name": "max_inspections", "required": false, + "serverDefault": 5, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "integer", "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/bucket.ts#L1091-L1115" - }, - { - "kind": "interface", - "name": { - "name": "KnnSearch", - "namespace": "_types" - }, - "properties": [ + }, { - "description": "The name of the vector field to search against", - "name": "field", - "required": true, + "description": "The maximum threshold in number of documents in which a suggest text token can exist in order to be included.\nCan be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.\nIf a value higher than 1 is specified, then fractional can not be specified.", + "name": "max_term_freq", + "required": false, + "serverDefault": 0.01, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "float", "namespace": "_types" } } }, { - "description": "The query vector", - "name": "query_vector", + "description": "The minimal threshold in number of documents a suggestion should appear in.\nThis can improve quality by only suggesting high frequency terms.\nCan be specified as an absolute number or as a relative percentage of number of documents.\nIf a value higher than 1 is specified, then the number cannot be fractional.", + "name": "min_doc_freq", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "QueryVector", + "name": "float", "namespace": "_types" } } }, { - "description": "The query vector builder. You must provide a query_vector_builder or query_vector, but not both.", - "name": "query_vector_builder", + "description": "The minimum length a suggest text term must have in order to be included.", + "name": "min_word_length", "required": false, + "serverDefault": 4, "type": { "kind": "instance_of", "type": { - "name": "QueryVectorBuilder", + "name": "integer", "namespace": "_types" } } }, { - "description": "The final number of nearest neighbors to return as top hits", - "name": "k", + "description": "The number of minimal prefix characters that must match in order be a candidate for suggestions.\nIncreasing this number improves spellcheck performance.", + "name": "prefix_length", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -70722,8 +74001,8 @@ } }, { - "description": "The number of nearest neighbor candidates to consider per shard", - "name": "num_candidates", + "description": "Sets the maximum number of suggestions to be retrieved from each individual shard.", + "name": "shard_size", "required": false, "type": { "kind": "instance_of", @@ -70734,360 +74013,297 @@ } }, { - "description": "Boost value to apply to kNN scores", - "name": "boost", + "description": "Defines how suggestions should be sorted per suggest text term.", + "name": "sort", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "SuggestSort", + "namespace": "_global.search._types" } } }, { - "description": "Filters for the kNN search query", - "name": "filter", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - } - ], - "kind": "union_of" - } - }, - { - "description": "The minimum similarity for a vector to be considered a match", - "name": "similarity", + "description": "The string distance implementation to use for comparing how similar suggested terms are.", + "name": "string_distance", "required": false, + "serverDefault": "internal", "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "StringDistance", + "namespace": "_global.search._types" } } }, { - "description": "If defined, each search hit will contain inner hits.", - "docId": "knn-inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#nested-knn-search-inner-hits", - "name": "inner_hits", + "description": "Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested.", + "name": "suggest_mode", "required": false, "type": { "kind": "instance_of", "type": { - "name": "InnerHits", - "namespace": "_global.search._types" + "name": "SuggestMode", + "namespace": "_types" } } }, { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "since": "8.18.0", - "stability": "experimental" - } - }, - "description": "Apply oversampling and rescoring to quantized vectors *", - "name": "rescore_vector", + "description": "The suggest text.\nNeeds to be set globally or per suggestion.", + "name": "text", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RescoreVector", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/Knn.ts#L35-L62" + "specLocation": "_global/search/_types/suggester.ts#L506-L568" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "description": "Sort by score first, then document frequency and then the term itself.", + "name": "score" + }, + { + "description": "Sort by document frequency first, then similarity score and then the term itself.", + "name": "frequency" + } + ], "name": { - "name": "Rescore", + "name": "SuggestSort", "namespace": "_global.search._types" }, - "properties": [ + "specLocation": "_global/search/_types/suggester.ts#L495-L504" + }, + { + "kind": "enum", + "members": [ { - "containerProperty": true, - "name": "window_size", - "required": false, - "type": { + "description": "Based on the Damerau-Levenshtein algorithm, but highly optimized for comparing string distance for terms inside the index.", + "name": "internal" + }, + { + "description": "String distance algorithm based on Damerau-Levenshtein algorithm.", + "name": "damerau_levenshtein" + }, + { + "description": "String distance algorithm based on the Levenshtein edit distance algorithm.", + "name": "levenshtein" + }, + { + "description": "String distance algorithm based on Jaro-Winkler algorithm.", + "name": "jaro_winkler" + }, + { + "description": "String distance algorithm based on character n-grams.", + "name": "ngram" + } + ], + "name": { + "name": "StringDistance", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/suggester.ts#L472-L493" + }, + { + "codegenNames": [ + "result", + "failure" + ], + "generics": [ + { + "name": "TDocument", + "namespace": "_global.msearch.ResponseItem" + } + ], + "kind": "type_alias", + "name": { + "name": "ResponseItem", + "namespace": "_global.msearch" + }, + "specLocation": "_global/msearch/types.ts#L211-L214", + "type": { + "items": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.msearch.ResponseItem" + } + } + ], "kind": "instance_of", "type": { - "name": "integer", + "name": "MultiSearchItem", + "namespace": "_global.msearch" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ErrorResponseBase", "namespace": "_types" } } - }, + ], + "kind": "union_of" + } + }, + { + "generics": [ { - "name": "query", - "required": false, - "type": { + "name": "TDocument", + "namespace": "_global.msearch.MultiSearchItem" + } + ], + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "RescoreQuery", - "namespace": "_global.search._types" + "name": "TDocument", + "namespace": "_global.msearch.MultiSearchItem" } } - }, + ], + "type": { + "name": "ResponseBody", + "namespace": "_global.search" + } + }, + "kind": "interface", + "name": { + "name": "MultiSearchItem", + "namespace": "_global.msearch" + }, + "properties": [ { - "name": "learning_to_rank", + "name": "status", "required": false, "type": { "kind": "instance_of", "type": { - "name": "LearningToRank", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "_global/search/_types/rescoring.ts#L25-L38", - "variants": { - "kind": "container", - "nonExhaustive": true - } + "specLocation": "_global/msearch/types.ts#L216-L219" }, { + "generics": [ + { + "name": "TDocument", + "namespace": "_global.search.ResponseBody" + } + ], "kind": "interface", "name": { - "name": "RescoreQuery", - "namespace": "_global.search._types" + "name": "ResponseBody", + "namespace": "_global.search" }, "properties": [ { - "codegenName": "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.", - "name": "rescore_query", + "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", + "name": "took", "required": true, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "description": "Relative importance of the original query versus the rescore query.", - "name": "query_weight", - "required": false, - "serverDefault": 1, - "type": { - "kind": "instance_of", - "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "description": "Relative importance of the rescore query versus the original query.", - "name": "rescore_query_weight", - "required": false, - "serverDefault": 1, + "description": "If `true`, the request timed out before completion; returned results may be partial or empty.", + "name": "timed_out", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Determines how scores are combined.", - "name": "score_mode", - "required": false, - "serverDefault": "total", + "description": "A count of shards used for the request.", + "name": "_shards", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ScoreMode", - "namespace": "_global.search._types" + "name": "ShardStatistics", + "namespace": "_types" } } - } - ], - "specLocation": "_global/search/_types/rescoring.ts#L40-L62" - }, - { - "kind": "enum", - "members": [ - { - "description": "Average the original score and the rescore query score.", - "name": "avg" - }, - { - "description": "Take the max of original score and the rescore query score.", - "name": "max" - }, - { - "description": "Take the min of the original score and the rescore query score.", - "name": "min" - }, - { - "description": "Multiply the original score by the rescore query score.\nUseful for `function` query rescores.", - "name": "multiply" }, { - "description": "Add the original score and the rescore query score.", - "name": "total" - } - ], - "name": { - "name": "ScoreMode", - "namespace": "_global.search._types" - }, - "specLocation": "_global/search/_types/rescoring.ts#L64-L86" - }, - { - "kind": "interface", - "name": { - "name": "LearningToRank", - "namespace": "_global.search._types" - }, - "properties": [ - { - "description": "The unique identifier of the trained model uploaded to Elasticsearch", - "name": "model_id", + "description": "The returned documents and metadata.", + "name": "hits", "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.search.ResponseBody" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "HitsMetadata", + "namespace": "_global.search._types" } } }, { - "description": "Named parameters to be passed to the query templates used for feature", - "name": "params", + "name": "aggregations", "required": false, "type": { "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "AggregateName", + "namespace": "_types" } }, "kind": "dictionary_of", "singleKey": false, "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "Aggregate", + "namespace": "_types.aggregations" + } } } - } - ], - "specLocation": "_global/search/_types/rescoring.ts#L88-L97" - }, - { - "kind": "type_alias", - "name": { - "name": "SortResults", - "namespace": "_types" - }, - "specLocation": "_types/sort.ts#L106-L106", - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", + }, + { + "name": "_clusters", + "required": false, "type": { - "name": "FieldValue", - "namespace": "_types" - } - } - } - }, - { - "codegenNames": [ - "enabled", - "count" - ], - "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.", - "kind": "type_alias", - "name": { - "name": "TrackHits", - "namespace": "_global.search._types" - }, - "specLocation": "_global/search/_types/hits.ts#L143-L151", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { "kind": "instance_of", "type": { - "name": "integer", + "name": "ClusterStatistics", "namespace": "_types" } } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "RuntimeFields", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/RuntimeFields.ts#L24-L24", - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "RuntimeField", - "namespace": "_types.mapping" - } - } - } - }, - { - "kind": "interface", - "name": { - "name": "RuntimeField", - "namespace": "_types.mapping" - }, - "properties": [ { - "description": "For type `composite`", "name": "fields", "required": false, "type": { @@ -71101,187 +74317,222 @@ "kind": "dictionary_of", "singleKey": false, "value": { - "kind": "instance_of", - "type": { - "name": "CompositeSubField", - "namespace": "_types.mapping" - } + "kind": "user_defined_value" } } }, { - "description": "For type `lookup`", - "name": "fetch_fields", + "name": "max_score", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RuntimeFieldFetchFields", - "namespace": "_types.mapping" - } + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } }, { - "description": "A custom format for `date` type runtime fields.", - "docId": "mapping-date-format", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html", - "name": "format", + "name": "num_reduce_phases", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "description": "For type `lookup`", - "name": "input_field", + "name": "profile", "required": false, "type": { "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" + "type": { + "name": "Profile", + "namespace": "_global.search._types" } } }, { - "description": "For type `lookup`", - "name": "target_field", + "name": "pit_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "Id", "namespace": "_types" } } }, { - "description": "For type `lookup`", - "name": "target_index", + "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.", + "extDocId": "scroll-search-results", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "name": "_scroll_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "ScrollId", "namespace": "_types" } } }, { - "description": "Painless script executed at query time.", - "name": "script", + "name": "suggest", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "SuggestionName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.search.ResponseBody" + } + } + ], + "kind": "instance_of", + "type": { + "name": "Suggest", + "namespace": "_global.search._types" + } + } } } }, { - "description": "Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`.", - "name": "type", - "required": true, + "name": "terminated_early", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "RuntimeFieldType", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "_types/mapping/RuntimeFields.ts#L26-L50" + "specLocation": "_global/search/SearchResponse.ts#L38-L84" }, { "kind": "interface", "name": { - "name": "CompositeSubField", - "namespace": "_types.mapping" + "name": "ShardStatistics", + "namespace": "_types" }, "properties": [ { - "name": "type", + "description": "The number of shards the operation or search attempted to run on but failed.", + "name": "failed", "required": true, "type": { "kind": "instance_of", "type": { - "name": "RuntimeFieldType", - "namespace": "_types.mapping" + "name": "uint", + "namespace": "_types" } } - } - ], - "specLocation": "_types/mapping/RuntimeFields.ts#L52-L54" - }, - { - "kind": "enum", - "members": [ - { - "name": "boolean" - }, - { - "name": "composite" - }, - { - "name": "date" - }, - { - "name": "double" - }, - { - "name": "geo_point" - }, - { - "name": "geo_shape" }, { - "name": "ip" + "description": "The number of shards the operation or search succeeded on.", + "name": "successful", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "uint", + "namespace": "_types" + } + } }, { - "name": "keyword" + "description": "The number of shards the operation or search will run on overall.", + "name": "total", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "uint", + "namespace": "_types" + } + } }, { - "name": "long" + "name": "failures", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardFailure", + "namespace": "_types" + } + } + } }, { - "name": "lookup" + "name": "skipped", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "uint", + "namespace": "_types" + } + } } ], + "specLocation": "_types/Stats.ts#L54-L69" + }, + { + "kind": "type_alias", "name": { - "name": "RuntimeFieldType", - "namespace": "_types.mapping" + "name": "uint", + "namespace": "_types" }, - "specLocation": "_types/mapping/RuntimeFields.ts#L62-L73" + "specLocation": "_types/Numeric.ts#L23-L23", + "type": { + "kind": "instance_of", + "type": { + "name": "number", + "namespace": "_builtins" + } + } }, { "kind": "interface", "name": { - "name": "RuntimeFieldFetchFields", - "namespace": "_types.mapping" + "name": "ShardFailure", + "namespace": "_types" }, "properties": [ { - "name": "field", - "required": true, + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "format", + "name": "node", "required": false, "type": { "kind": "instance_of", @@ -71290,298 +74541,421 @@ "namespace": "_builtins" } } - } - ], - "shortcutProperty": "field", - "specLocation": "_types/mapping/RuntimeFields.ts#L56-L60" - }, - { - "kind": "interface", - "name": { - "name": "PointInTimeReference", - "namespace": "_global.search._types" - }, - "properties": [ + }, { - "name": "id", + "name": "reason", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "ErrorCause", "namespace": "_types" } } }, { - "name": "keep_alive", - "required": false, + "name": "shard", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } + }, + { + "name": "status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "_global/search/_types/PointInTimeReference.ts#L23-L26" + "specLocation": "_types/Errors.ts#L52-L58" }, { - "attachedBehaviors": [ - "AdditionalProperties" + "generics": [ + { + "name": "T", + "namespace": "_global.search._types.HitsMetadata" + } ], - "behaviors": [ + "kind": "interface", + "name": { + "name": "HitsMetadata", + "namespace": "_global.search._types" + }, + "properties": [ { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "description": "Total hit count information, present only if `track_total_hits` wasn't `false` in the search request.", + "name": "total", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "TotalHits", + "namespace": "_global.search._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - }, - { + ], + "kind": "union_of" + } + }, + { + "name": "hits", + "required": true, + "type": { + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "T", + "namespace": "_global.search._types.HitsMetadata" + } + } + ], "kind": "instance_of", "type": { - "name": "FieldSuggester", + "name": "Hit", "namespace": "_global.search._types" } } - ], - "meta": { - "description": "The named suggesters", - "fieldname": "suggesters" - }, + } + }, + { + "name": "max_score", + "required": false, "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } } ], + "specLocation": "_global/search/_types/hits.ts#L67-L73" + }, + { "kind": "interface", "name": { - "name": "Suggester", + "name": "TotalHits", "namespace": "_global.search._types" }, "properties": [ { - "description": "Global suggest text, to avoid repetition when the same text is used in several suggesters", - "name": "text", - "required": false, + "name": "relation", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TotalHitsRelation", + "namespace": "_global.search._types" + } + } + }, + { + "name": "value", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } } ], - "specLocation": "_global/search/_types/suggester.ts#L101-L107" + "specLocation": "_global/search/_types/hits.ts#L95-L98" + }, + { + "kind": "enum", + "members": [ + { + "description": "Accurate", + "name": "eq" + }, + { + "description": "Lower bound, including returned events or sequences", + "name": "gte" + } + ], + "name": { + "name": "TotalHitsRelation", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/hits.ts#L100-L105" }, { + "generics": [ + { + "name": "TDocument", + "namespace": "_global.search._types.Hit" + } + ], "kind": "interface", "name": { - "name": "FieldSuggester", + "name": "Hit", "namespace": "_global.search._types" }, "properties": [ { - "description": "Provides auto-complete/search-as-you-type functionality.", - "name": "completion", - "required": false, + "name": "_index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "CompletionSuggester", - "namespace": "_global.search._types" + "name": "IndexName", + "namespace": "_types" } } }, { - "description": "Provides access to word alternatives on a per token basis within a certain string distance.", - "name": "phrase", + "esQuirk": "'_id' is not available when using 'stored_fields: _none_'\non a search request. Otherwise the field is always present on hits.", + "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "PhraseSuggester", - "namespace": "_global.search._types" + "name": "Id", + "namespace": "_types" } } }, { - "description": "Suggests terms based on edit distance.", - "name": "term", + "name": "_score", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "TermSuggester", - "namespace": "_global.search._types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "containerProperty": true, - "description": "Prefix used to search for suggestions.", - "name": "prefix", + "name": "_explanation", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Explanation", + "namespace": "_global.explain" } } }, { - "containerProperty": true, - "description": "A prefix expressed as a regular expression.", - "name": "regex", + "name": "fields", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "containerProperty": true, - "description": "The text to use as input for the suggester.\nNeeds to be set globally or per suggestion.", - "name": "text", + "name": "highlight", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L109-L142", - "variants": { - "kind": "container", - "nonExhaustive": true - } - }, - { - "inherits": { - "type": { - "name": "SuggesterBase", - "namespace": "_global.search._types" - } - }, - "kind": "interface", - "name": { - "name": "CompletionSuggester", - "namespace": "_global.search._types" - }, - "properties": [ + }, { - "description": "A value, geo point object, or a geo hash string to filter or boost the suggestion on.", - "name": "contexts", + "name": "inner_hits", "required": false, "type": { "key": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } }, "kind": "dictionary_of", "singleKey": false, "value": { - "items": [ - { + "kind": "instance_of", + "type": { + "name": "InnerHitsResult", + "namespace": "_global.search._types" + } + } + } + }, + { + "name": "matched_queries", + "required": false, + "type": { + "items": [ + { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "CompletionContext", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CompletionContext", - "namespace": "_global.search._types" - } + } + }, + { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } - ], - "kind": "union_of" - } + } + ], + "kind": "union_of" } }, { - "description": "Enables fuzziness, meaning you can have a typo in your search and still get results back.", - "name": "fuzzy", + "name": "_nested", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SuggestFuzziness", + "name": "NestedIdentity", "namespace": "_global.search._types" } } }, { - "description": "A regex query that expresses a prefix as a regular expression.", - "name": "regex", + "name": "_ignored", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "RegexOptions", - "namespace": "_global.search._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "Whether duplicate suggestions should be filtered out.", - "name": "skip_duplicates", + "name": "ignored_field_values", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "kind": "user_defined_value" + } + } + } + }, + { + "name": "_shard", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L163-L181" - }, - { - "kind": "interface", - "name": { - "name": "SuggesterBase", - "namespace": "_global.search._types" - }, - "properties": [ + }, { - "description": "The field to fetch the candidate suggestions from.\nNeeds to be set globally or per suggestion.", - "name": "field", - "required": true, + "name": "_node", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The analyzer to analyze the suggest text with.\nDefaults to the search analyzer of the suggest field.", - "name": "analyzer", + "name": "_routing", "required": false, "type": { "kind": "instance_of", @@ -71592,1496 +74966,1105 @@ } }, { - "description": "The maximum corrections to be returned per suggest text token.", - "name": "size", + "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TDocument", + "namespace": "_global.search._types.Hit" } } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L144-L159" - }, - { - "kind": "interface", - "name": { - "name": "CompletionContext", - "namespace": "_global.search._types" - }, - "properties": [ + }, { - "description": "The factor by which the score of the suggestion should be boosted.\nThe score is computed by multiplying the boost with the suggestion weight.", - "name": "boost", + "name": "_rank", "required": false, - "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } }, { - "description": "The value of the category to filter/boost on.", - "name": "context", - "required": true, + "name": "_seq_no", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Context", - "namespace": "_global.search._types" + "name": "SequenceNumber", + "namespace": "_types" } } }, { - "description": "An array of precision values at which neighboring geohashes should be taken into account.\nPrecision value can be a distance value (`5m`, `10km`, etc.) or a raw geohash precision (`1`..`12`).\nDefaults to generating neighbors for index time precision level.", - "name": "neighbours", + "name": "_primary_term", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "GeoHashPrecision", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "description": "The precision of the geohash to encode the query geo point.\nCan be specified as a distance value (`5m`, `10km`, etc.), or as a raw geohash precision (`1`..`12`).\nDefaults to index time precision level.", - "name": "precision", + "name": "_version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoHashPrecision", + "name": "VersionNumber", "namespace": "_types" } } }, { - "description": "Whether the category value should be treated as a prefix or not.", - "name": "prefix", + "name": "sort", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "SortResults", + "namespace": "_types" } } } ], - "shortcutProperty": "context", - "specLocation": "_global/search/_types/suggester.ts#L235-L264" + "specLocation": "_global/search/_types/hits.ts#L40-L65" }, { - "codegenNames": [ - "category", - "location" - ], - "description": "Text or location that we want similar documents for or a lookup to a document's field for the text.", - "docId": "document-input-parameters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", - "kind": "type_alias", + "kind": "interface", "name": { - "name": "Context", - "namespace": "_global.search._types" + "name": "Explanation", + "namespace": "_global.explain" }, - "specLocation": "_global/search/_types/suggester.ts#L228-L233", - "type": { - "items": [ - { + "properties": [ + { + "name": "description", + "required": true, + "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "GeoLocation", - "namespace": "_types" - } } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "SuggestFuzziness", - "namespace": "_global.search._types" - }, - "properties": [ + }, { - "description": "The fuzziness factor.", - "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", - "name": "fuzziness", - "required": false, - "serverDefault": "AUTO", + "name": "details", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Fuzziness", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ExplanationDetail", + "namespace": "_global.explain" + } } } }, { - "description": "Minimum length of the input before fuzzy suggestions are returned.", - "name": "min_length", - "required": false, - "serverDefault": 3, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "float", "namespace": "_types" } } - }, + } + ], + "specLocation": "_global/explain/types.ts#L22-L26" + }, + { + "kind": "interface", + "name": { + "name": "ExplanationDetail", + "namespace": "_global.explain" + }, + "properties": [ { - "description": "Minimum length of the input, which is not checked for fuzzy alternatives.", - "name": "prefix_length", - "required": false, - "serverDefault": 1, + "name": "description", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "If set to `true`, transpositions are counted as one change instead of two.", - "name": "transpositions", + "name": "details", "required": false, - "serverDefault": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ExplanationDetail", + "namespace": "_global.explain" + } } } }, { - "description": "If `true`, all measurements (like fuzzy edit distance, transpositions, and lengths) are measured in Unicode code points instead of in bytes.\nThis is slightly slower than raw bytes.", - "name": "unicode_aware", - "required": false, - "serverDefault": false, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "float", + "namespace": "_types" } } } ], - "specLocation": "_global/search/_types/suggester.ts#L196-L224" + "specLocation": "_global/explain/types.ts#L28-L32" }, { "kind": "interface", "name": { - "name": "RegexOptions", + "name": "InnerHitsResult", "namespace": "_global.search._types" }, "properties": [ { - "description": "Optional operators for the regular expression.", - "docId": "regexp-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", - "name": "flags", - "required": false, + "name": "hits", + "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, + "generics": [ { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "user_defined_value" } ], - "kind": "union_of" - } - }, - { - "description": "Maximum number of automaton states required for the query.", - "name": "max_determinized_states", - "required": false, - "serverDefault": 10000, - "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "HitsMetadata", + "namespace": "_global.search._types" } } } ], - "specLocation": "_global/search/_types/suggester.ts#L183-L194" + "specLocation": "_global/search/_types/hits.ts#L85-L87" }, { - "inherits": { - "type": { - "name": "SuggesterBase", - "namespace": "_global.search._types" - } - }, "kind": "interface", "name": { - "name": "PhraseSuggester", + "name": "NestedIdentity", "namespace": "_global.search._types" }, "properties": [ { - "description": "Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index.", - "name": "collate", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "PhraseSuggestCollate", - "namespace": "_global.search._types" + "name": "Field", + "namespace": "_types" } } }, { - "description": "Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates.\nOnly candidates that score higher than the threshold will be included in the result.", - "name": "confidence", - "required": false, - "serverDefault": 1, + "name": "offset", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } }, { - "description": "A list of candidate generators that produce a list of possible terms per term in the given text.", - "name": "direct_generator", + "name": "_nested", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DirectGenerator", - "namespace": "_global.search._types" - } + "kind": "instance_of", + "type": { + "name": "NestedIdentity", + "namespace": "_global.search._types" } } - }, - { - "name": "force_unigrams", - "required": false, - "type": { + } + ], + "specLocation": "_global/search/_types/hits.ts#L89-L93" + }, + { + "description": "The aggregation name as returned from the server. Depending whether typed_keys is specified this could come back\nin the form of `name#type` instead of simply `name`", + "kind": "type_alias", + "name": { + "name": "AggregateName", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L142-L146", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "extDocId": "search-aggregations", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html", + "kind": "type_alias", + "name": { + "name": "Aggregate", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/Aggregate.ts#L38-L125", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "CardinalityAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "HdrPercentilesAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "HdrPercentileRanksAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TDigestPercentilesAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TDigestPercentileRanksAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PercentilesBucketAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MedianAbsoluteDeviationAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MinAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MaxAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SumAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "AvgAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "WeightedAvgAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ValueCountAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SimpleValueAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DerivativeAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "BucketMetricValueAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StatsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StatsBucketAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ExtendedStatsAggregate", + "namespace": "_types.aggregations" + } + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ExtendedStatsBucketAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Sets max size of the n-grams (shingles) in the field.\nIf the field doesn’t contain n-grams (shingles), this should be omitted or set to `1`.\nIf the field uses a shingle filter, the `gram_size` is set to the `max_shingle_size` if not explicitly set.", - "name": "gram_size", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "GeoBoundsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Sets up suggestion highlighting.\nIf not provided, no highlighted field is returned.", - "name": "highlight", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "PhraseSuggestHighlight", - "namespace": "_global.search._types" + "name": "GeoCentroidAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The maximum percentage of the terms considered to be misspellings in order to form a correction.\nThis method accepts a float value in the range `[0..1)` as a fraction of the actual query terms or a number `>=1` as an absolute number of query terms.", - "name": "max_errors", - "required": false, - "serverDefault": 1, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "HistogramAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The likelihood of a term being misspelled even if the term exists in the dictionary.", - "name": "real_word_error_likelihood", - "required": false, - "serverDefault": 0.95, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "DateHistogramAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The separator that is used to separate terms in the bigram field.\nIf not set, the whitespace character is used as a separator.", - "name": "separator", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "AutoDateHistogramAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Sets the maximum number of suggested terms to be retrieved from each individual shard.", - "name": "shard_size", - "required": false, - "serverDefault": 5, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "VariableWidthHistogramAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index).\nThe default model is Stupid Backoff.", - "name": "smoothing", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "SmoothingModelContainer", - "namespace": "_global.search._types" + "name": "StringTermsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The text/query to provide suggestions for.", - "name": "text", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "LongTermsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "name": "token_limit", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "DoubleTermsAggregate", + "namespace": "_types.aggregations" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L359-L417" - }, - { - "kind": "interface", - "name": { - "name": "PhraseSuggestCollate", - "namespace": "_global.search._types" - }, - "properties": [ - { - "description": "Parameters to use if the query is templated.", - "name": "params", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + }, + { + "kind": "instance_of", + "type": { + "name": "UnmappedTermsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Returns all suggestions with an extra `collate_match` option indicating whether the generated phrase matched any document.", - "name": "prune", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "LongRareTermsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "A collate query that is run once for every suggestion.", - "name": "query", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "PhraseSuggestCollateQuery", - "namespace": "_global.search._types" + "name": "StringRareTermsAggregate", + "namespace": "_types.aggregations" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L333-L346" - }, - { - "kind": "interface", - "name": { - "name": "PhraseSuggestCollateQuery", - "namespace": "_global.search._types" - }, - "properties": [ - { - "description": "The search template ID.", - "name": "id", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "UnmappedRareTermsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The query source.", - "name": "source", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "MultiTermsAggregate", + "namespace": "_types.aggregations" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L348-L357" - }, - { - "kind": "interface", - "name": { - "name": "DirectGenerator", - "namespace": "_global.search._types" - }, - "properties": [ - { - "description": "The field to fetch the candidate suggestions from.\nNeeds to be set globally or per suggestion.", - "name": "field", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "MissingAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.\nCan only be `1` or `2`.", - "name": "max_edits", - "required": false, - "serverDefault": 2, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "NestedAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.\nCan improve accuracy at the cost of performance.", - "name": "max_inspections", - "required": false, - "serverDefault": 5, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "ReverseNestedAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The maximum threshold in number of documents in which a suggest text token can exist in order to be included.\nThis can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked.\nCan be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.\nIf a value higher than 1 is specified, then fractional can not be specified.", - "name": "max_term_freq", - "required": false, - "serverDefault": 0.01, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "GlobalAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The minimal threshold in number of documents a suggestion should appear in.\nThis can improve quality by only suggesting high frequency terms.\nCan be specified as an absolute number or as a relative percentage of number of documents.\nIf a value higher than 1 is specified, the number cannot be fractional.", - "name": "min_doc_freq", - "required": false, - "serverDefault": 0, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "FilterAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The minimum length a suggest text term must have in order to be included.", - "name": "min_word_length", - "required": false, - "serverDefault": 4, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "ChildrenAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer.", - "name": "post_filter", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ParentAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "A filter (analyzer) that is applied to each of the tokens passed to this candidate generator.\nThis filter is applied to the original token before candidates are generated.", - "name": "pre_filter", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SamplerAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The number of minimal prefix characters that must match in order be a candidate suggestions.\nIncreasing this number improves spellcheck performance.", - "name": "prefix_length", - "required": false, - "serverDefault": 1, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "UnmappedSamplerAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The maximum corrections to be returned per suggest text token.", - "name": "size", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "GeoHashGridAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Controls what suggestions are included on the suggestions generated on each shard.", - "name": "suggest_mode", - "required": false, - "serverDefault": "missing", - "type": { + }, + { "kind": "instance_of", "type": { - "name": "SuggestMode", - "namespace": "_types" + "name": "GeoTileGridAggregate", + "namespace": "_types.aggregations" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L268-L331" - }, - { - "kind": "enum", - "members": [ - { - "description": "Only generate suggestions for terms that are not in the shard.", - "name": "missing" - }, - { - "description": "Only suggest terms that occur in more docs on the shard than the original term.", - "name": "popular" - }, - { - "description": "Suggest any matching suggestions based on terms in the suggest text.", - "name": "always" - } - ], - "name": { - "name": "SuggestMode", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L279-L292" - }, - { - "kind": "interface", - "name": { - "name": "PhraseSuggestHighlight", - "namespace": "_global.search._types" - }, - "properties": [ - { - "description": "Use in conjunction with `pre_tag` to define the HTML tags to use for the highlighted text.", - "name": "post_tag", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "GeoHexGridAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Use in conjunction with `post_tag` to define the HTML tags to use for the highlighted text.", - "name": "pre_tag", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "RangeAggregate", + "namespace": "_types.aggregations" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L419-L428" - }, - { - "kind": "interface", - "name": { - "name": "SmoothingModelContainer", - "namespace": "_global.search._types" - }, - "properties": [ - { - "description": "A smoothing model that uses an additive smoothing where a constant (typically `1.0` or smaller) is added to all counts to balance weights.", - "name": "laplace", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "LaplaceSmoothingModel", - "namespace": "_global.search._types" + "name": "DateRangeAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "A smoothing model that takes the weighted mean of the unigrams, bigrams, and trigrams based on user supplied weights (lambdas).", - "name": "linear_interpolation", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "LinearInterpolationSmoothingModel", - "namespace": "_global.search._types" + "name": "GeoDistanceAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "A simple backoff model that backs off to lower order n-gram models if the higher order count is `0` and discounts the lower order n-gram model by a constant factor.", - "name": "stupid_backoff", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StupidBackoffSmoothingModel", - "namespace": "_global.search._types" + "name": "IpRangeAggregate", + "namespace": "_types.aggregations" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L445-L461", - "variants": { - "kind": "container" - } - }, - { - "kind": "interface", - "name": { - "name": "LaplaceSmoothingModel", - "namespace": "_global.search._types" - }, - "properties": [ - { - "description": "A constant that is added to all counts to balance weights.", - "name": "alpha", - "required": true, - "type": { + }, + { + "kind": "instance_of", + "type": { + "name": "IpPrefixAggregate", + "namespace": "_types.aggregations" + } + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "FiltersAggregate", + "namespace": "_types.aggregations" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L430-L435" - }, - { - "kind": "interface", - "name": { - "name": "LinearInterpolationSmoothingModel", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "bigram_lambda", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "AdjacencyMatrixAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "name": "trigram_lambda", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "SignificantLongTermsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "name": "unigram_lambda", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "SignificantStringTermsAggregate", + "namespace": "_types.aggregations" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L437-L441" - }, - { - "kind": "interface", - "name": { - "name": "StupidBackoffSmoothingModel", - "namespace": "_global.search._types" - }, - "properties": [ - { - "description": "A constant factor that the lower order n-gram model is discounted by.", - "name": "discount", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "UnmappedSignificantTermsAggregate", + "namespace": "_types.aggregations" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L463-L468" - }, - { - "inherits": { - "type": { - "name": "SuggesterBase", - "namespace": "_global.search._types" - } - }, - "kind": "interface", - "name": { - "name": "TermSuggester", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "lowercase_terms", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "CompositeAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The maximum edit distance candidate suggestions can have in order to be considered as a suggestion.\nCan only be `1` or `2`.", - "name": "max_edits", - "required": false, - "serverDefault": 2, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "FrequentItemSetsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level.\nCan improve accuracy at the cost of performance.", - "name": "max_inspections", - "required": false, - "serverDefault": 5, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TimeSeriesAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The maximum threshold in number of documents in which a suggest text token can exist in order to be included.\nCan be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies.\nIf a value higher than 1 is specified, then fractional can not be specified.", - "name": "max_term_freq", - "required": false, - "serverDefault": 0.01, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "ScriptedMetricAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The minimal threshold in number of documents a suggestion should appear in.\nThis can improve quality by only suggesting high frequency terms.\nCan be specified as an absolute number or as a relative percentage of number of documents.\nIf a value higher than 1 is specified, then the number cannot be fractional.", - "name": "min_doc_freq", - "required": false, - "serverDefault": 0, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "TopHitsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The minimum length a suggest text term must have in order to be included.", - "name": "min_word_length", - "required": false, - "serverDefault": 4, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "InferenceAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The number of minimal prefix characters that must match in order be a candidate for suggestions.\nIncreasing this number improves spellcheck performance.", - "name": "prefix_length", - "required": false, - "serverDefault": 1, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "StringStatsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Sets the maximum number of suggestions to be retrieved from each individual shard.", - "name": "shard_size", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "BoxPlotAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Defines how suggestions should be sorted per suggest text term.", - "name": "sort", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "SuggestSort", - "namespace": "_global.search._types" + "name": "TopMetricsAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The string distance implementation to use for comparing how similar suggested terms are.", - "name": "string_distance", - "required": false, - "serverDefault": "internal", - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StringDistance", - "namespace": "_global.search._types" + "name": "TTestAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested.", - "name": "suggest_mode", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "SuggestMode", - "namespace": "_types" + "name": "RateAggregate", + "namespace": "_types.aggregations" } - } - }, - { - "description": "The suggest text.\nNeeds to be set globally or per suggestion.", - "name": "text", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CumulativeCardinalityAggregate", + "namespace": "_types.aggregations" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L506-L568" - }, - { - "kind": "enum", - "members": [ - { - "description": "Sort by score first, then document frequency and then the term itself.", - "name": "score" - }, - { - "description": "Sort by document frequency first, then similarity score and then the term itself.", - "name": "frequency" - } - ], - "name": { - "name": "SuggestSort", - "namespace": "_global.search._types" - }, - "specLocation": "_global/search/_types/suggester.ts#L495-L504" - }, - { - "kind": "enum", - "members": [ - { - "description": "Based on the Damerau-Levenshtein algorithm, but highly optimized for comparing string distance for terms inside the index.", - "name": "internal" - }, - { - "description": "String distance algorithm based on Damerau-Levenshtein algorithm.", - "name": "damerau_levenshtein" - }, - { - "description": "String distance algorithm based on the Levenshtein edit distance algorithm.", - "name": "levenshtein" - }, - { - "description": "String distance algorithm based on Jaro-Winkler algorithm.", - "name": "jaro_winkler" - }, - { - "description": "String distance algorithm based on character n-grams.", - "name": "ngram" - } - ], - "name": { - "name": "StringDistance", - "namespace": "_global.search._types" - }, - "specLocation": "_global/search/_types/suggester.ts#L472-L493" - }, - { - "codegenNames": [ - "result", - "failure" - ], - "generics": [ - { - "name": "TDocument", - "namespace": "_global.msearch.ResponseItem" - } - ], - "kind": "type_alias", - "name": { - "name": "ResponseItem", - "namespace": "_global.msearch" - }, - "specLocation": "_global/msearch/types.ts#L211-L214", - "type": { - "items": [ + }, { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.msearch.ResponseItem" - } - } - ], "kind": "instance_of", "type": { - "name": "MultiSearchItem", - "namespace": "_global.msearch" + "name": "MatrixStatsAggregate", + "namespace": "_types.aggregations" } }, { "kind": "instance_of", "type": { - "name": "ErrorResponseBase", - "namespace": "_types" + "name": "GeoLineAggregate", + "namespace": "_types.aggregations" } } ], "kind": "union_of" + }, + "variants": { + "kind": "external_tag", + "nonExhaustive": true } }, { - "generics": [ - { - "name": "TDocument", - "namespace": "_global.msearch.MultiSearchItem" - } - ], "inherits": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.msearch.MultiSearchItem" - } - } - ], "type": { - "name": "ResponseBody", - "namespace": "_global.search" + "name": "AggregateBase", + "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "MultiSearchItem", - "namespace": "_global.msearch" + "name": "CardinalityAggregate", + "namespace": "_types.aggregations" }, "properties": [ { - "name": "status", - "required": false, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } } ], - "specLocation": "_global/msearch/types.ts#L216-L219" + "specLocation": "_types/aggregations/Aggregate.ts#L140-L143", + "variantName": "cardinality" }, { - "generics": [ - { - "name": "TDocument", - "namespace": "_global.search.ResponseBody" - } - ], "kind": "interface", "name": { - "name": "ResponseBody", - "namespace": "_global.search" + "name": "AggregateBase", + "namespace": "_types.aggregations" }, - "properties": [ - { - "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", - "name": "took", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "If `true`, the request timed out before completion; returned results may be partial or empty.", - "name": "timed_out", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "A count of shards used for the request.", - "name": "_shards", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ShardStatistics", - "namespace": "_types" - } - } - }, - { - "description": "The returned documents and metadata.", - "name": "hits", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.search.ResponseBody" - } - } - ], - "kind": "instance_of", - "type": { - "name": "HitsMetadata", - "namespace": "_global.search._types" - } - } - }, - { - "name": "aggregations", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "AggregateName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" - } - } - } - }, - { - "name": "_clusters", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ClusterStatistics", - "namespace": "_types" - } - } - }, - { - "name": "fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "max_score", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, + "properties": [ { - "name": "num_reduce_phases", + "name": "meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Metadata", "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L136-L138" + }, + { + "inherits": { + "type": { + "name": "PercentilesAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "HdrPercentilesAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L168-L169", + "variantName": "hdr_percentiles" + }, + { + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "PercentilesAggregateBase", + "namespace": "_types.aggregations" + }, + "properties": [ { - "name": "profile", - "required": false, + "name": "values", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Profile", - "namespace": "_global.search._types" + "name": "Percentiles", + "namespace": "_types.aggregations" } } - }, - { - "name": "pit_id", - "required": false, - "type": { + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L148-L150" + }, + { + "codegenNames": [ + "keyed", + "array" + ], + "kind": "type_alias", + "name": { + "name": "Percentiles", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/Aggregate.ts#L152-L153", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "KeyedPercentiles", + "namespace": "_types.aggregations" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ArrayPercentilesItem", + "namespace": "_types.aggregations" + } } } - }, - { - "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.", - "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", - "name": "_scroll_id", - "required": false, + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "KeyedPercentiles", + "namespace": "_types.aggregations" + }, + "specLocation": "_types/aggregations/Aggregate.ts#L160-L160", + "type": { + "key": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "ScrollId", - "namespace": "_types" - } + "name": "string", + "namespace": "_builtins" } }, - { - "name": "suggest", - "required": false, - "type": { - "key": { + "kind": "dictionary_of", + "singleKey": false, + "value": { + "items": [ + { "kind": "instance_of", "type": { - "name": "SuggestionName", + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "long", "namespace": "_types" } }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.search.ResponseBody" - } - } - ], - "kind": "instance_of", - "type": { - "name": "Suggest", - "namespace": "_global.search._types" - } + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" } } - } - }, - { - "name": "terminated_early", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + ], + "kind": "union_of" } - ], - "specLocation": "_global/search/SearchResponse.ts#L38-L84" + } }, { "kind": "interface", "name": { - "name": "ShardStatistics", - "namespace": "_types" + "name": "ArrayPercentilesItem", + "namespace": "_types.aggregations" }, "properties": [ { - "description": "The number of shards the operation or search attempted to run on but failed.", - "name": "failed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "uint", - "namespace": "_types" - } - } - }, - { - "description": "The number of shards the operation or search succeeded on.", - "name": "successful", + "name": "key", "required": true, "type": { "kind": "instance_of", "type": { - "name": "uint", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The number of shards the operation or search will run on overall.", - "name": "total", + "name": "value", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "uint", - "namespace": "_types" - } - } - }, - { - "name": "failures", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardFailure", - "namespace": "_types" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } } - } + ], + "kind": "union_of" } }, { - "name": "skipped", + "name": "value_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "uint", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/Stats.ts#L54-L69" + "specLocation": "_types/aggregations/Aggregate.ts#L162-L166" }, { - "kind": "type_alias", + "inherits": { + "type": { + "name": "PercentilesAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", "name": { - "name": "uint", - "namespace": "_types" + "name": "HdrPercentileRanksAggregate", + "namespace": "_types.aggregations" }, - "specLocation": "_types/Numeric.ts#L23-L23", - "type": { - "kind": "instance_of", + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L171-L172", + "variantName": "hdr_percentile_ranks" + }, + { + "inherits": { "type": { - "name": "number", - "namespace": "_builtins" + "name": "PercentilesAggregateBase", + "namespace": "_types.aggregations" } - } + }, + "kind": "interface", + "name": { + "name": "TDigestPercentilesAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L174-L175", + "variantName": "tdigest_percentiles" }, { + "inherits": { + "type": { + "name": "PercentilesAggregateBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "ShardFailure", - "namespace": "_types" + "name": "TDigestPercentileRanksAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L177-L178", + "variantName": "tdigest_percentile_ranks" + }, + { + "inherits": { + "type": { + "name": "PercentilesAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "PercentilesBucketAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L180-L181", + "variantName": "percentiles_bucket" + }, + { + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MedianAbsoluteDeviationAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L196-L197", + "variantName": "median_absolute_deviation" + }, + { + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" }, "properties": [ { - "name": "index", - "required": false, + "description": "The metric value. A missing value generally means that there was no data to aggregate,\nunless specified otherwise.", + "name": "value", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "node", + "name": "value_as_string", "required": false, "type": { "kind": "instance_of", @@ -73090,31 +76073,165 @@ "namespace": "_builtins" } } - }, - { - "name": "reason", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ErrorCause", - "namespace": "_types" - } - } - }, + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L185-L194" + }, + { + "extDocId": "search-aggregations-metrics-min-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html", + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MinAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L199-L203", + "variantName": "min" + }, + { + "extDocId": "search-aggregations-metrics-max-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html", + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MaxAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L205-L209", + "variantName": "max" + }, + { + "description": "Sum aggregation result. `value` is always present and is zero if there were no values to process.", + "extDocId": "search-aggregations-metrics-sum-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html", + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SumAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L211-L216", + "variantName": "sum" + }, + { + "extDocId": "search-aggregations-metrics-avg-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html", + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "AvgAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L218-L222", + "variantName": "avg" + }, + { + "description": "Weighted average aggregation result. `value` is missing if the weight was set to zero.", + "extDocId": "search-aggregations-metrics-weight-avg-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-weight-avg-aggregation.html", + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "WeightedAvgAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L224-L229", + "variantName": "weighted_avg" + }, + { + "description": "Value count aggregation result. `value` is always present.", + "extDocId": "search-aggregations-metrics-valuecount-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html", + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "ValueCountAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L231-L236", + "variantName": "value_count" + }, + { + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SimpleValueAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L238-L239", + "variantName": "simple_value" + }, + { + "extDocId": "search-aggregations-pipeline-derivative-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-derivative-aggregation.html", + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "DerivativeAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ { - "name": "shard", - "required": true, + "name": "normalized_value", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "name": "status", + "name": "normalized_value_as_string", "required": false, "type": { "kind": "instance_of", @@ -73125,39 +76242,84 @@ } } ], - "specLocation": "_types/Errors.ts#L52-L58" + "specLocation": "_types/aggregations/Aggregate.ts#L241-L248", + "variantName": "derivative" }, { - "generics": [ + "inherits": { + "type": { + "name": "SingleMetricAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "BucketMetricValueAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ { - "name": "T", - "namespace": "_global.search._types.HitsMetadata" + "name": "keys", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } } ], + "specLocation": "_types/aggregations/Aggregate.ts#L250-L253", + "variantName": "bucket_metric_value" + }, + { + "description": "Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process\n(`count` is zero).", + "extDocId": "search-aggregations-metrics-stats-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html", + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "HitsMetadata", - "namespace": "_global.search._types" + "name": "StatsAggregate", + "namespace": "_types.aggregations" }, "properties": [ { - "description": "Total hit count information, present only if `track_total_hits` wasn't `false` in the search request.", - "name": "total", - "required": false, + "name": "count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "min", + "required": true, "type": { "items": [ { "kind": "instance_of", "type": { - "name": "TotalHits", - "namespace": "_global.search._types" + "name": "double", + "namespace": "_types" } }, { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "null", + "namespace": "_builtins" } } ], @@ -73165,31 +76327,31 @@ } }, { - "name": "hits", + "name": "max", "required": true, "type": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "T", - "namespace": "_global.search._types.HitsMetadata" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" } - ], - "kind": "instance_of", - "type": { - "name": "Hit", - "namespace": "_global.search._types" } - } + ], + "kind": "union_of" } }, { - "name": "max_score", - "required": false, + "name": "avg", + "required": true, "type": { "items": [ { @@ -73209,99 +76371,102 @@ ], "kind": "union_of" } - } - ], - "specLocation": "_global/search/_types/hits.ts#L67-L73" - }, - { - "kind": "interface", - "name": { - "name": "TotalHits", - "namespace": "_global.search._types" - }, - "properties": [ + }, { - "name": "relation", + "name": "sum", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TotalHitsRelation", - "namespace": "_global.search._types" + "name": "double", + "namespace": "_types" } } }, { - "name": "value", - "required": true, + "name": "min_as_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_global/search/_types/hits.ts#L95-L98" - }, - { - "kind": "enum", - "members": [ - { - "description": "Accurate", - "name": "eq" }, { - "description": "Lower bound, including returned events or sequences", - "name": "gte" - } - ], - "name": { - "name": "TotalHitsRelation", - "namespace": "_global.search._types" - }, - "specLocation": "_global/search/_types/hits.ts#L100-L105" - }, - { - "generics": [ - { - "name": "TDocument", - "namespace": "_global.search._types.Hit" - } - ], - "kind": "interface", - "name": { - "name": "Hit", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "_index", - "required": true, + "name": "max_as_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "esQuirk": "'_id' is not available when using 'stored_fields: _none_'\non a search request. Otherwise the field is always present on hits.", - "name": "_id", + "name": "avg_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_score", + "name": "sum_as_string", "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L257-L273", + "variantName": "stats" + }, + { + "extDocId": "search-aggregations-pipeline-stats-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-stats-bucket-aggregation.html", + "inherits": { + "type": { + "name": "StatsAggregate", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "StatsBucketAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L275-L279", + "variantName": "stats_bucket" + }, + { + "extDocId": "search-aggregations-metrics-extendedstats-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-extendedstats-aggregation.html", + "inherits": { + "type": { + "name": "StatsAggregate", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "ExtendedStatsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "sum_of_squares", + "required": true, "type": { "items": [ { @@ -73323,112 +76488,68 @@ } }, { - "name": "_explanation", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Explanation", - "namespace": "_global.explain" - } - } - }, - { - "name": "fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "highlight", - "required": false, + "name": "variance", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "array_of", - "value": { + "items": [ + { "kind": "instance_of", "type": { - "name": "string", + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", "namespace": "_builtins" } } - } + ], + "kind": "union_of" } }, { - "name": "inner_hits", - "required": false, + "name": "variance_population", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "InnerHitsResult", - "namespace": "_global.search._types" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } } - } + ], + "kind": "union_of" } }, { - "name": "matched_queries", - "required": false, + "name": "variance_sampling", + "required": true, "type": { "items": [ { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } }, { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" } } ], @@ -73436,163 +76557,110 @@ } }, { - "name": "_nested", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "NestedIdentity", - "namespace": "_global.search._types" - } - } - }, - { - "name": "_ignored", - "required": false, + "name": "std_deviation", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } } - } + ], + "kind": "union_of" } }, { - "name": "ignored_field_values", - "required": false, + "name": "std_deviation_population", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "kind": "user_defined_value" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } } - } - } - }, - { - "name": "_shard", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "_node", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "_routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "_source", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.search._types.Hit" - } + ], + "kind": "union_of" } }, { - "name": "_rank", - "required": false, + "name": "std_deviation_sampling", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "_seq_no", + "name": "std_deviation_bounds", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "StandardDeviationBounds", + "namespace": "_types.aggregations" } } }, { - "name": "_primary_term", + "name": "sum_of_squares_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_version", + "name": "variance_as_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "sort", + "name": "variance_population_as_string", "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SortResults", - "namespace": "_types" - } - } - } - ], - "specLocation": "_global/search/_types/hits.ts#L40-L65" - }, - { - "kind": "interface", - "name": { - "name": "Explanation", - "namespace": "_global.explain" - }, - "properties": [ - { - "name": "description", - "required": true, "type": { "kind": "instance_of", "type": { @@ -73602,43 +76670,19 @@ } }, { - "name": "details", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ExplanationDetail", - "namespace": "_global.explain" - } - } - } - }, - { - "name": "value", - "required": true, + "name": "variance_sampling_as_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_global/explain/types.ts#L22-L26" - }, - { - "kind": "interface", - "name": { - "name": "ExplanationDetail", - "namespace": "_global.explain" - }, - "properties": [ + }, { - "name": "description", - "required": true, + "name": "std_deviation_as_string", + "required": false, "type": { "kind": "instance_of", "type": { @@ -73648,628 +76692,807 @@ } }, { - "name": "details", + "name": "std_deviation_bounds_as_string", "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ExplanationDetail", - "namespace": "_global.explain" - } - } - } - }, - { - "name": "value", - "required": true, "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "StandardDeviationBoundsAsString", + "namespace": "_types.aggregations" } } } ], - "specLocation": "_global/explain/types.ts#L28-L32" + "specLocation": "_types/aggregations/Aggregate.ts#L299-L320", + "variantName": "extended_stats" }, { "kind": "interface", "name": { - "name": "InnerHitsResult", - "namespace": "_global.search._types" + "name": "StandardDeviationBounds", + "namespace": "_types.aggregations" }, "properties": [ { - "name": "hits", + "name": "upper", "required": true, "type": { - "generics": [ + "items": [ { - "kind": "user_defined_value" - } - ], - "kind": "instance_of", - "type": { - "name": "HitsMetadata", - "namespace": "_global.search._types" - } - } - } - ], - "specLocation": "_global/search/_types/hits.ts#L85-L87" - }, - { - "kind": "interface", - "name": { - "name": "NestedIdentity", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "offset", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "_nested", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "NestedIdentity", - "namespace": "_global.search._types" - } - } - } - ], - "specLocation": "_global/search/_types/hits.ts#L89-L93" - }, - { - "description": "The aggregation name as returned from the server. Depending whether typed_keys is specified this could come back\nin the form of `name#type` instead of simply `name`", - "kind": "type_alias", - "name": { - "name": "AggregateName", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L142-L146", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "extDocId": "search-aggregations", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html", - "kind": "type_alias", - "name": { - "name": "Aggregate", - "namespace": "_types.aggregations" - }, - "specLocation": "_types/aggregations/Aggregate.ts#L38-L125", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "CardinalityAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "HdrPercentilesAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "HdrPercentileRanksAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TDigestPercentilesAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TDigestPercentileRanksAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "PercentilesBucketAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "MedianAbsoluteDeviationAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "MinAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "MaxAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SumAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "AvgAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "WeightedAvgAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ValueCountAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SimpleValueAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DerivativeAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "BucketMetricValueAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StatsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StatsBucketAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ExtendedStatsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ExtendedStatsBucketAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GeoBoundsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GeoCentroidAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "HistogramAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DateHistogramAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "AutoDateHistogramAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "VariableWidthHistogramAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StringTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "LongTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DoubleTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "UnmappedTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "LongRareTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StringRareTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "UnmappedRareTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "MultiTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "MissingAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "NestedAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ReverseNestedAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GlobalAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "FilterAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ChildrenAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ParentAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SamplerAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "UnmappedSamplerAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GeoHashGridAggregate", - "namespace": "_types.aggregations" - } - }, - { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "lower", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "upper_population", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "lower_population", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "upper_sampling", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "lower_sampling", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L281-L288" + }, + { + "kind": "interface", + "name": { + "name": "StandardDeviationBoundsAsString", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "upper", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "GeoTileGridAggregate", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "lower", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "GeoHexGridAggregate", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "upper_population", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "RangeAggregate", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "lower_population", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "DateRangeAggregate", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "upper_sampling", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "GeoDistanceAggregate", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "lower_sampling", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "IpRangeAggregate", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } - }, - { + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L290-L297" + }, + { + "inherits": { + "type": { + "name": "ExtendedStatsAggregate", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "ExtendedStatsBucketAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L322-L323", + "variantName": "extended_stats_bucket" + }, + { + "extDocId": "search-aggregations-metrics-geobounds-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "GeoBoundsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "bounds", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IpPrefixAggregate", - "namespace": "_types.aggregations" + "name": "GeoBounds", + "namespace": "_types" } - }, - { + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L327-L333", + "variantName": "geo_bounds" + }, + { + "extDocId": "search-aggregations-metrics-geocentroid-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geocentroid-aggregation.html", + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "GeoCentroidAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "count", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "FiltersAggregate", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } - }, - { + } + }, + { + "name": "location", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "AdjacencyMatrixAggregate", - "namespace": "_types.aggregations" + "name": "GeoLocation", + "namespace": "_types" } - }, + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L335-L342", + "variantName": "geo_centroid" + }, + { + "extDocId": "search-aggregations-bucket-histogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html", + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "SignificantLongTermsAggregate", + "name": "HistogramBucket", "namespace": "_types.aggregations" } - }, - { + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "HistogramAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L372-L376", + "variantName": "histogram" + }, + { + "generics": [ + { + "name": "TBucket", + "namespace": "_types.aggregations.MultiBucketAggregateBase" + } + ], + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "buckets", + "required": true, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TBucket", + "namespace": "_types.aggregations.MultiBucketAggregateBase" + } + } + ], "kind": "instance_of", "type": { - "name": "SignificantStringTermsAggregate", + "name": "Buckets", "namespace": "_types.aggregations" } - }, + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L357-L359" + }, + { + "extDocId": "search-aggregations-bucket-datehistogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html", + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "UnmappedSignificantTermsAggregate", + "name": "DateHistogramBucket", "namespace": "_types.aggregations" } - }, + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "DateHistogramAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L383-L386", + "variantName": "date_histogram" + }, + { + "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "CompositeAggregate", + "name": "DateHistogramBucket", "namespace": "_types.aggregations" } - }, - { + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "AutoDateHistogramAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "interval", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "FrequentItemSetsAggregate", - "namespace": "_types.aggregations" + "name": "DurationLarge", + "namespace": "_types" } - }, + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L393-L400", + "variantName": "auto_date_histogram" + }, + { + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "TimeSeriesAggregate", + "name": "VariableWidthHistogramBucket", "namespace": "_types.aggregations" } - }, + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "VariableWidthHistogramAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L402-L404", + "variantName": "variable_width_histogram" + }, + { + "description": "Result of a `terms` aggregation when the field is a string.", + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "ScriptedMetricAggregate", + "name": "StringTermsBucket", "namespace": "_types.aggregations" } - }, + } + ], + "type": { + "name": "TermsAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "StringTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L424-L429", + "variantName": "sterms" + }, + { + "generics": [ + { + "name": "TBucket", + "namespace": "_types.aggregations.TermsAggregateBase" + } + ], + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "TopHitsAggregate", - "namespace": "_types.aggregations" + "name": "TBucket", + "namespace": "_types.aggregations.TermsAggregateBase" } - }, - { + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "TermsAggregateBase", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "doc_count_error_upper_bound", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "InferenceAggregate", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } - }, - { + } + }, + { + "name": "sum_other_doc_count", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "StringStatsAggregate", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } - }, + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L417-L422" + }, + { + "description": "Result of a `terms` aggregation when the field is some kind of whole number like a integer, long, or a date.", + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "BoxPlotAggregate", + "name": "LongTermsBucket", "namespace": "_types.aggregations" } - }, + } + ], + "type": { + "name": "TermsAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "LongTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L439-L444", + "variantName": "lterms" + }, + { + "description": "Result of a `terms` aggregation when the field is some kind of decimal number like a float, double, or distance.", + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "TopMetricsAggregate", + "name": "DoubleTermsBucket", "namespace": "_types.aggregations" } - }, + } + ], + "type": { + "name": "TermsAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "DoubleTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L451-L456", + "variantName": "dterms" + }, + { + "description": "Result of a `terms` aggregation when the field is unmapped. `buckets` is always empty.", + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "TTestAggregate", - "namespace": "_types.aggregations" + "name": "Void", + "namespace": "_spec_utils" } - }, + } + ], + "type": { + "name": "TermsAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "UnmappedTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L463-L469", + "variantName": "umterms" + }, + { + "description": "Result of the `rare_terms` aggregation when the field is some kind of whole number like a integer, long, or a date.", + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "RateAggregate", + "name": "LongRareTermsBucket", "namespace": "_types.aggregations" } - }, + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "LongRareTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L471-L476", + "variantName": "lrareterms" + }, + { + "description": "Result of the `rare_terms` aggregation when the field is a string.", + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "CumulativeCardinalityAggregate", + "name": "StringRareTermsBucket", "namespace": "_types.aggregations" } - }, + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "StringRareTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L483-L487", + "variantName": "srareterms" + }, + { + "description": "Result of a `rare_terms` aggregation when the field is unmapped. `buckets` is always empty.", + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "MatrixStatsAggregate", - "namespace": "_types.aggregations" + "name": "Void", + "namespace": "_spec_utils" } - }, + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "UnmappedRareTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L493-L499", + "variantName": "umrareterms" + }, + { + "extDocId": "search-aggregations-bucket-multi-terms-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-multi-terms-aggregation.html", + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "GeoLineAggregate", + "name": "MultiTermsBucket", "namespace": "_types.aggregations" } } ], - "kind": "union_of" + "type": { + "name": "TermsAggregateBase", + "namespace": "_types.aggregations" + } }, - "variants": { - "kind": "external_tag", - "nonExhaustive": true - } + "kind": "interface", + "name": { + "name": "MultiTermsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L501-L506", + "variantName": "multi_terms" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "extDocId": "search-aggregations-bucket-missing-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-missing-aggregation.html", + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "MissingAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L528-L532", + "variantName": "missing" }, { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "AggregateName", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "Aggregate", + "namespace": "_types.aggregations" + } + } + ], + "meta": { + "description": "Nested aggregations", + "fieldname": "aggregations" + }, + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], + "description": "Base type for single-bucket aggregation results that can hold sub-aggregations results.", "inherits": { "type": { "name": "AggregateBase", @@ -74278,12 +77501,12 @@ }, "kind": "interface", "name": { - "name": "CardinalityAggregate", + "name": "SingleBucketAggregateBase", "namespace": "_types.aggregations" }, "properties": [ { - "name": "value", + "name": "doc_count", "required": true, "type": { "kind": "instance_of", @@ -74294,482 +77517,817 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L140-L143", - "variantName": "cardinality" + "specLocation": "_types/aggregations/Aggregate.ts#L516-L526" }, { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "extDocId": "search-aggregations-bucket-nested-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-nested-aggregation.html", + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "AggregateBase", + "name": "NestedAggregate", "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "meta", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" - } - } + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L534-L538", + "variantName": "nested" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "extDocId": "search-aggregations-bucket-reverse-nested-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-reverse-nested-aggregation.html", + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" } + }, + "kind": "interface", + "name": { + "name": "ReverseNestedAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L540-L544", + "variantName": "reverse_nested" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" ], - "specLocation": "_types/aggregations/Aggregate.ts#L136-L138" + "extDocId": "search-aggregations-bucket-global-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html", + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "GlobalAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L546-L550", + "variantName": "global" }, { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "extDocId": "search-aggregations-bucket-filter-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html", "inherits": { "type": { - "name": "PercentilesAggregateBase", + "name": "SingleBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "HdrPercentilesAggregate", + "name": "FilterAggregate", "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L168-L169", - "variantName": "hdr_percentiles" + "specLocation": "_types/aggregations/Aggregate.ts#L552-L556", + "variantName": "filter" }, { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "extDocId": "search-aggregations-bucket-children-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-children-aggregation.html", "inherits": { "type": { - "name": "AggregateBase", + "name": "SingleBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "PercentilesAggregateBase", + "name": "ChildrenAggregate", "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "values", - "required": true, - "type": { + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L888-L892", + "variantName": "children" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "extDocId": "search-aggregations-bucket-parent-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-parent-aggregation.html", + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "ParentAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L894-L898", + "variantName": "parent" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "SamplerAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L558-L559", + "variantName": "sampler" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "inherits": { + "type": { + "name": "SingleBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "UnmappedSamplerAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L561-L562", + "variantName": "unmapped_sampler" + }, + { + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "Percentiles", + "name": "GeoHashGridBucket", "namespace": "_types.aggregations" } } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L148-L150" + }, + "kind": "interface", + "name": { + "name": "GeoHashGridAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L566-L568", + "variantName": "geohash_grid" }, { - "codegenNames": [ - "keyed", - "array" - ], - "kind": "type_alias", + "extDocId": "search-aggregations-bucket-geotilegrid-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geotilegrid-aggregation.html", + "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "GeoTileGridBucket", + "namespace": "_types.aggregations" + } + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", "name": { - "name": "Percentiles", + "name": "GeoTileGridAggregate", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/Aggregate.ts#L152-L153", - "type": { - "items": [ + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L574-L579", + "variantName": "geotile_grid" + }, + { + "inherits": { + "generics": [ { "kind": "instance_of", "type": { - "name": "KeyedPercentiles", + "name": "GeoHexGridBucket", "namespace": "_types.aggregations" } - }, + } + ], + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "GeoHexGridAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L585-L586", + "variantName": "geohex_grid" + }, + { + "extDocId": "search-aggregations-bucket-range-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html", + "inherits": { + "generics": [ { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ArrayPercentilesItem", - "namespace": "_types.aggregations" - } + "kind": "instance_of", + "type": { + "name": "RangeBucket", + "namespace": "_types.aggregations" } } ], - "kind": "union_of" - } + "type": { + "name": "MultiBucketAggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "RangeAggregate", + "namespace": "_types.aggregations" + }, + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L594-L598", + "variantName": "range" }, { - "kind": "type_alias", + "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.", + "extDocId": "search-aggregations-bucket-daterange-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html", + "inherits": { + "type": { + "name": "RangeAggregate", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", "name": { - "name": "KeyedPercentiles", + "name": "DateRangeAggregate", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/Aggregate.ts#L160-L160", - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - } + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L609-L615", + "variantName": "date_range" }, { + "description": "Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default.", + "extDocId": "search-aggregations-bucket-geodistance-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html", + "inherits": { + "type": { + "name": "RangeAggregate", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "ArrayPercentilesItem", + "name": "GeoDistanceAggregate", "namespace": "_types.aggregations" }, - "properties": [ - { - "name": "key", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "value", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "value_as_string", - "required": false, - "type": { + "properties": [], + "specLocation": "_types/aggregations/Aggregate.ts#L617-L622", + "variantName": "geo_distance" + }, + { + "extDocId": "search-aggregations-bucket-iprange-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html", + "inherits": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IpRangeBucket", + "namespace": "_types.aggregations" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L162-L166" - }, - { - "inherits": { + ], "type": { - "name": "PercentilesAggregateBase", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "HdrPercentileRanksAggregate", + "name": "IpRangeAggregate", "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L171-L172", - "variantName": "hdr_percentile_ranks" + "specLocation": "_types/aggregations/Aggregate.ts#L624-L629", + "variantName": "ip_range" }, { + "extDocId": "search-aggregations-bucket-ipprefix-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-ipprefix-aggregation.html", "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "IpPrefixBucket", + "namespace": "_types.aggregations" + } + } + ], "type": { - "name": "PercentilesAggregateBase", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "TDigestPercentilesAggregate", + "name": "IpPrefixAggregate", "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L174-L175", - "variantName": "tdigest_percentiles" + "specLocation": "_types/aggregations/Aggregate.ts#L709-L713", + "variantName": "ip_prefix" }, { + "extDocId": "search-aggregations-bucket-filters-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html", "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "FiltersBucket", + "namespace": "_types.aggregations" + } + } + ], "type": { - "name": "PercentilesAggregateBase", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "TDigestPercentileRanksAggregate", + "name": "FiltersAggregate", "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L177-L178", - "variantName": "tdigest_percentile_ranks" + "specLocation": "_types/aggregations/Aggregate.ts#L639-L643", + "variantName": "filters" }, { + "extDocId": "search-aggregations-bucket-adjacency-matrix-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-adjacency-matrix-aggregation.html", "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "AdjacencyMatrixBucket", + "namespace": "_types.aggregations" + } + } + ], "type": { - "name": "PercentilesAggregateBase", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "PercentilesBucketAggregate", + "name": "AdjacencyMatrixAggregate", "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L180-L181", - "variantName": "percentiles_bucket" + "specLocation": "_types/aggregations/Aggregate.ts#L647-L652", + "variantName": "adjacency_matrix" }, { "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "SignificantLongTermsBucket", + "namespace": "_types.aggregations" + } + } + ], "type": { - "name": "SingleMetricAggregateBase", + "name": "SignificantTermsAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "MedianAbsoluteDeviationAggregate", + "name": "SignificantLongTermsAggregate", "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L196-L197", - "variantName": "median_absolute_deviation" + "specLocation": "_types/aggregations/Aggregate.ts#L668-L670", + "variantName": "siglterms" }, { + "extDocId": "search-aggregations-bucket-significanttext-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "generics": [ + { + "name": "T", + "namespace": "_types.aggregations.SignificantTermsAggregateBase" + } + ], "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "T", + "namespace": "_types.aggregations.SignificantTermsAggregateBase" + } + } + ], "type": { - "name": "AggregateBase", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "SingleMetricAggregateBase", + "name": "SignificantTermsAggregateBase", "namespace": "_types.aggregations" }, "properties": [ { - "description": "The metric value. A missing value generally means that there was no data to aggregate,\nunless specified otherwise.", - "name": "value", - "required": true, + "name": "bg_count", + "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } }, { - "name": "value_as_string", + "name": "doc_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L185-L194" + "specLocation": "_types/aggregations/Aggregate.ts#L658-L666" }, { - "extDocId": "search-aggregations-metrics-min-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html", "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "SignificantStringTermsBucket", + "namespace": "_types.aggregations" + } + } + ], "type": { - "name": "SingleMetricAggregateBase", + "name": "SignificantTermsAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "MinAggregate", + "name": "SignificantStringTermsAggregate", "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L199-L203", - "variantName": "min" + "specLocation": "_types/aggregations/Aggregate.ts#L682-L684", + "variantName": "sigsterms" }, { - "extDocId": "search-aggregations-metrics-max-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html", + "description": "Result of the `significant_terms` aggregation on an unmapped field. `buckets` is always empty.", "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "Void", + "namespace": "_spec_utils" + } + } + ], "type": { - "name": "SingleMetricAggregateBase", + "name": "SignificantTermsAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "MaxAggregate", + "name": "UnmappedSignificantTermsAggregate", "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L205-L209", - "variantName": "max" + "specLocation": "_types/aggregations/Aggregate.ts#L690-L696", + "variantName": "umsigterms" }, { - "description": "Sum aggregation result. `value` is always present and is zero if there were no values to process.", - "extDocId": "search-aggregations-metrics-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html", "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "CompositeBucket", + "namespace": "_types.aggregations" + } + } + ], "type": { - "name": "SingleMetricAggregateBase", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "SumAggregate", + "name": "CompositeAggregate", "namespace": "_types.aggregations" }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L211-L216", - "variantName": "sum" + "properties": [ + { + "name": "after_key", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CompositeAggregateKey", + "namespace": "_types.aggregations" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L698-L703", + "variantName": "composite" }, { - "extDocId": "search-aggregations-metrics-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html", "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "FrequentItemSetsBucket", + "namespace": "_types.aggregations" + } + } + ], "type": { - "name": "SingleMetricAggregateBase", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "AvgAggregate", + "name": "FrequentItemSetsAggregate", "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L218-L222", - "variantName": "avg" + "specLocation": "_types/aggregations/Aggregate.ts#L722-L723", + "variantName": "frequent_item_sets" }, { - "description": "Weighted average aggregation result. `value` is missing if the weight was set to zero.", - "extDocId": "search-aggregations-metrics-weight-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-weight-avg-aggregation.html", "inherits": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TimeSeriesBucket", + "namespace": "_types.aggregations" + } + } + ], "type": { - "name": "SingleMetricAggregateBase", + "name": "MultiBucketAggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "WeightedAvgAggregate", + "name": "TimeSeriesAggregate", "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L224-L229", - "variantName": "weighted_avg" + "specLocation": "_types/aggregations/Aggregate.ts#L730-L731", + "variantName": "time_series" }, { - "description": "Value count aggregation result. `value` is always present.", - "extDocId": "search-aggregations-metrics-valuecount-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html", + "extDocId": "search-aggregations-metrics-scripted-metric-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-scripted-metric-aggregation.html", "inherits": { "type": { - "name": "SingleMetricAggregateBase", + "name": "AggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "ValueCountAggregate", + "name": "ScriptedMetricAggregate", "namespace": "_types.aggregations" }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L231-L236", - "variantName": "value_count" + "properties": [ + { + "name": "value", + "required": true, + "type": { + "kind": "user_defined_value" + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L739-L745", + "variantName": "scripted_metric" }, { + "extDocId": "search-aggregations-metrics-top-hits-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html", "inherits": { "type": { - "name": "SingleMetricAggregateBase", + "name": "AggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "SimpleValueAggregate", + "name": "TopHitsAggregate", "namespace": "_types.aggregations" }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L238-L239", - "variantName": "simple_value" + "properties": [ + { + "name": "hits", + "required": true, + "type": { + "generics": [ + { + "kind": "user_defined_value" + } + ], + "kind": "instance_of", + "type": { + "name": "HitsMetadata", + "namespace": "_global.search._types" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L747-L753", + "variantName": "top_hits" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "user_defined_value" + } + ], + "meta": { + "description": "Additional data", + "fieldname": "data" + }, + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], + "extDocId": "search-aggregations-pipeline-inference-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-inference-bucket-aggregation.html", + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "InferenceAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "value", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } + }, + { + "name": "feature_importance", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceFeatureImportance", + "namespace": "_types.aggregations" + } + } + } + }, + { + "name": "top_classes", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceTopClassEntry", + "namespace": "_types.aggregations" + } + } + } + }, + { + "name": "warning", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L755-L770", + "variantName": "inference" }, { - "extDocId": "search-aggregations-pipeline-derivative-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-derivative-aggregation.html", - "inherits": { - "type": { - "name": "SingleMetricAggregateBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "DerivativeAggregate", + "name": "InferenceFeatureImportance", "namespace": "_types.aggregations" }, "properties": [ { - "name": "normalized_value", + "name": "feature_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "importance", "required": false, "type": { "kind": "instance_of", @@ -74780,8 +78338,32 @@ } }, { - "name": "normalized_value_as_string", + "name": "classes", "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceClassImportance", + "namespace": "_types.aggregations" + } + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L778-L782" + }, + { + "kind": "interface", + "name": { + "name": "InferenceClassImportance", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "class_name", + "required": true, "type": { "kind": "instance_of", "type": { @@ -74789,46 +78371,65 @@ "namespace": "_builtins" } } + }, + { + "name": "importance", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L241-L248", - "variantName": "derivative" + "specLocation": "_types/aggregations/Aggregate.ts#L784-L787" }, { - "inherits": { - "type": { - "name": "SingleMetricAggregateBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "BucketMetricValueAggregate", + "name": "InferenceTopClassEntry", "namespace": "_types.aggregations" }, "properties": [ { - "name": "keys", + "name": "class_name", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } + }, + { + "name": "class_probability", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "class_score", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L250-L253", - "variantName": "bucket_metric_value" + "specLocation": "_types/aggregations/Aggregate.ts#L772-L776" }, { - "description": "Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process\n(`count` is zero).", - "extDocId": "search-aggregations-metrics-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -74837,7 +78438,7 @@ }, "kind": "interface", "name": { - "name": "StatsAggregate", + "name": "StringStatsAggregate", "namespace": "_types.aggregations" }, "properties": [ @@ -74853,7 +78454,53 @@ } }, { - "name": "min", + "name": "min_length", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "max_length", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "avg_length", "required": true, "type": { "items": [ @@ -74876,7 +78523,7 @@ } }, { - "name": "max", + "name": "entropy", "required": true, "type": { "items": [ @@ -74899,7 +78546,367 @@ } }, { - "name": "avg", + "name": "distribution", + "required": false, + "type": { + "items": [ + { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "min_length_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_length_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "avg_length_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L793-L804", + "variantName": "string_stats" + }, + { + "extDocId": "search-aggregations-metrics-boxplot-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-boxplot-aggregation.html", + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "BoxPlotAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "min", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "max", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "q1", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "q2", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "q3", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "lower", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "upper", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "min_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "q1_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "q2_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "q3_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "lower_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "upper_as_string", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L806-L825", + "variantName": "boxplot" + }, + { + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "TopMetricsAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "top", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TopMetrics", + "namespace": "_types.aggregations" + } + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L827-L830", + "variantName": "top_metrics" + }, + { + "kind": "interface", + "name": { + "name": "TopMetrics", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "sort", + "required": true, + "type": { + "kind": "array_of", + "value": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + } + }, + { + "name": "metrics", + "required": true, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + } + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L832-L836" + }, + { + "extDocId": "search-aggregations-metrics-ttest-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-ttest-aggregation.html", + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "TTestAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ + { + "name": "value", "required": true, "type": { "items": [ @@ -74922,29 +78929,48 @@ } }, { - "name": "sum", - "required": true, + "name": "value_as_string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L838-L845", + "variantName": "t_test" + }, + { + "extDocId": "search-aggregations-metrics-rate-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-rate-aggregation.html", + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "RateAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ { - "name": "min_as_string", - "required": false, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "name": "max_as_string", + "name": "value_as_string", "required": false, "type": { "kind": "instance_of", @@ -74953,20 +78979,38 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L847-L854", + "variantName": "rate" + }, + { + "description": "Result of the `cumulative_cardinality` aggregation", + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, + "kind": "interface", + "name": { + "name": "CumulativeCardinalityAggregate", + "namespace": "_types.aggregations" + }, + "properties": [ { - "name": "avg_as_string", - "required": false, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "sum_as_string", + "name": "value_as_string", "required": false, "type": { "kind": "instance_of", @@ -74977,812 +79021,746 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L257-L273", - "variantName": "stats" - }, - { - "extDocId": "search-aggregations-pipeline-stats-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-stats-bucket-aggregation.html", - "inherits": { - "type": { - "name": "StatsAggregate", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "StatsBucketAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L275-L279", - "variantName": "stats_bucket" + "specLocation": "_types/aggregations/Aggregate.ts#L856-L864", + "variantName": "simple_long_value" }, { - "extDocId": "search-aggregations-metrics-extendedstats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-extendedstats-aggregation.html", + "extDocId": "search-aggregations-matrix-stats-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-matrix-stats-aggregation.html", "inherits": { "type": { - "name": "StatsAggregate", + "name": "AggregateBase", "namespace": "_types.aggregations" } }, "kind": "interface", "name": { - "name": "ExtendedStatsAggregate", + "name": "MatrixStatsAggregate", "namespace": "_types.aggregations" }, "properties": [ { - "name": "sum_of_squares", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "variance", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "variance_population", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "variance_sampling", + "name": "doc_count", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } }, { - "name": "std_deviation", - "required": true, + "name": "fields", + "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "MatrixStatsFields", + "namespace": "_types.aggregations" } - ], - "kind": "union_of" + } } - }, + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L866-L873", + "variantName": "matrix_stats" + }, + { + "kind": "interface", + "name": { + "name": "MatrixStatsFields", + "namespace": "_types.aggregations" + }, + "properties": [ { - "name": "std_deviation_population", + "name": "name", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } } }, { - "name": "std_deviation_sampling", + "name": "count", "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "std_deviation_bounds", - "required": false, "type": { "kind": "instance_of", "type": { - "name": "StandardDeviationBounds", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } } }, { - "name": "sum_of_squares_as_string", - "required": false, + "name": "mean", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "name": "variance_as_string", - "required": false, + "name": "variance", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "name": "variance_population_as_string", - "required": false, + "name": "skewness", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "name": "variance_sampling_as_string", - "required": false, + "name": "kurtosis", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "name": "std_deviation_as_string", - "required": false, + "name": "covariance", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } } }, { - "name": "std_deviation_bounds_as_string", - "required": false, + "name": "correlation", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "StandardDeviationBoundsAsString", - "namespace": "_types.aggregations" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L299-L320", - "variantName": "extended_stats" + "specLocation": "_types/aggregations/Aggregate.ts#L875-L884" }, { + "extDocId": "search-aggregations-metrics-geo-line", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geo-line.html", + "inherits": { + "type": { + "name": "AggregateBase", + "namespace": "_types.aggregations" + } + }, "kind": "interface", "name": { - "name": "StandardDeviationBounds", + "name": "GeoLineAggregate", "namespace": "_types.aggregations" }, "properties": [ { - "name": "upper", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "lower", + "name": "type", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "upper_population", + "name": "geometry", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "GeoLine", + "namespace": "_types" + } } }, { - "name": "lower_population", + "name": "properties", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "user_defined_value" } - }, - { - "name": "upper_sampling", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + } + ], + "specLocation": "_types/aggregations/Aggregate.ts#L902-L912", + "variantName": "geo_line" + }, + { + "description": "A GeoJson GeoLine.", + "kind": "interface", + "name": { + "name": "GeoLine", + "namespace": "_types" + }, + "properties": [ + { + "description": "Always `\"LineString\"`", + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "lower_sampling", + "description": "Array of `[lon, lat]` coordinates", + "name": "coordinates", "required": true, "type": { - "items": [ - { + "kind": "array_of", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { "name": "double", "namespace": "_types" } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } } - ], - "kind": "union_of" + } } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L281-L288" + "specLocation": "_types/Geo.ts#L56-L62" }, { "kind": "interface", "name": { - "name": "StandardDeviationBoundsAsString", - "namespace": "_types.aggregations" + "name": "ClusterStatistics", + "namespace": "_types" }, "properties": [ { - "name": "upper", + "name": "skipped", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "lower", + "name": "successful", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "upper_population", + "name": "total", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "lower_population", + "name": "running", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "upper_sampling", + "name": "partial", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "lower_sampling", + "name": "failed", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "details", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "ClusterAlias", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterDetails", + "namespace": "_types" + } } } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L290-L297" + "specLocation": "_types/Stats.ts#L27-L35" }, { - "inherits": { - "type": { - "name": "ExtendedStatsAggregate", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", + "kind": "type_alias", "name": { - "name": "ExtendedStatsBucketAggregate", - "namespace": "_types.aggregations" + "name": "ClusterAlias", + "namespace": "_types" }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L322-L323", - "variantName": "extended_stats_bucket" - }, - { - "extDocId": "search-aggregations-metrics-geobounds-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", - "inherits": { + "specLocation": "_types/common.ts#L72-L72", + "type": { + "kind": "instance_of", "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } - }, + } + }, + { "kind": "interface", "name": { - "name": "GeoBoundsAggregate", - "namespace": "_types.aggregations" + "name": "ClusterDetails", + "namespace": "_types" }, "properties": [ { - "name": "bounds", - "required": false, + "name": "status", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "GeoBounds", + "name": "ClusterSearchStatus", "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L327-L333", - "variantName": "geo_bounds" - }, - { - "extDocId": "search-aggregations-metrics-geocentroid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geocentroid-aggregation.html", - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "GeoCentroidAggregate", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "count", + "name": "indices", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "took", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "DurationValue", "namespace": "_types" } } }, { - "name": "location", + "name": "timed_out", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "_shards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GeoLocation", + "name": "ShardStatistics", "namespace": "_types" } } + }, + { + "name": "failures", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardFailure", + "namespace": "_types" + } + } + } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L335-L342", - "variantName": "geo_centroid" + "specLocation": "_types/Stats.ts#L45-L52" }, { - "extDocId": "search-aggregations-bucket-histogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html", - "inherits": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "HistogramBucket", - "namespace": "_types.aggregations" - } - } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" + "kind": "enum", + "members": [ + { + "name": "running" + }, + { + "name": "successful" + }, + { + "name": "partial" + }, + { + "name": "skipped" + }, + { + "name": "failed" } - }, - "kind": "interface", + ], "name": { - "name": "HistogramAggregate", - "namespace": "_types.aggregations" + "name": "ClusterSearchStatus", + "namespace": "_types" }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L372-L376", - "variantName": "histogram" + "specLocation": "_types/Stats.ts#L37-L43" }, { "generics": [ { - "name": "TBucket", - "namespace": "_types.aggregations.MultiBucketAggregateBase" + "name": "Unit", + "namespace": "_types.DurationValue" } ], - "inherits": { + "kind": "type_alias", + "name": { + "name": "DurationValue", + "namespace": "_types" + }, + "specLocation": "_types/Time.ts#L67-L67", + "type": { + "kind": "instance_of", "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" + "name": "Unit", + "namespace": "_types.DurationValue" } - }, + } + }, + { "kind": "interface", "name": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" + "name": "Profile", + "namespace": "_global.search._types" }, "properties": [ { - "name": "buckets", + "name": "shards", "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TBucket", - "namespace": "_types.aggregations.MultiBucketAggregateBase" - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ShardProfile", + "namespace": "_global.search._types" } - ], - "kind": "instance_of", - "type": { - "name": "Buckets", - "namespace": "_types.aggregations" } } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L357-L359" + "specLocation": "_global/search/_types/profile.ts#L101-L103" }, { - "extDocId": "search-aggregations-bucket-datehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html", - "inherits": { - "generics": [ - { + "kind": "interface", + "name": { + "name": "ShardProfile", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "aggregations", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AggregationProfile", + "namespace": "_global.search._types" + } + } + } + }, + { + "name": "cluster", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "DateHistogramBucket", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "DateHistogramAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L383-L386", - "variantName": "date_histogram" - }, - { - "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", - "inherits": { - "generics": [ - { + }, + { + "name": "dfs", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DateHistogramBucket", - "namespace": "_types.aggregations" + "name": "DfsProfile", + "namespace": "_global.search._types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "AutoDateHistogramAggregate", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "interval", + "name": "fetch", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FetchProfile", + "namespace": "_global.search._types" + } + } + }, + { + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DurationLarge", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L393-L400", - "variantName": "auto_date_histogram" - }, - { - "inherits": { - "generics": [ - { + }, + { + "name": "node_id", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "VariableWidthHistogramBucket", - "namespace": "_types.aggregations" + "name": "NodeId", + "namespace": "_types" + } + } + }, + { + "name": "searches", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SearchProfile", + "namespace": "_global.search._types" + } + } + } + }, + { + "name": "shard_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" } - }, + ], + "specLocation": "_global/search/_types/profile.ts#L142-L152" + }, + { "kind": "interface", "name": { - "name": "VariableWidthHistogramAggregate", - "namespace": "_types.aggregations" + "name": "AggregationProfile", + "namespace": "_global.search._types" }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L402-L404", - "variantName": "variable_width_histogram" - }, - { - "description": "Result of a `terms` aggregation when the field is a string.", - "inherits": { - "generics": [ - { + "properties": [ + { + "name": "breakdown", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AggregationBreakdown", + "namespace": "_global.search._types" + } + } + }, + { + "name": "description", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "time_in_nanos", + "required": true, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitNanos", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "StringTermsBucket", - "namespace": "_types.aggregations" + "name": "DurationValue", + "namespace": "_types" } } - ], - "type": { - "name": "TermsAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "StringTermsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L424-L429", - "variantName": "sterms" - }, - { - "generics": [ + }, { - "name": "TBucket", - "namespace": "_types.aggregations.TermsAggregateBase" - } - ], - "inherits": { - "generics": [ - { + "name": "type", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "TBucket", - "namespace": "_types.aggregations.TermsAggregateBase" + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "debug", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AggregationProfileDebug", + "namespace": "_global.search._types" + } + } + }, + { + "name": "children", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "AggregationProfile", + "namespace": "_global.search._types" + } } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" } - }, + ], + "specLocation": "_global/search/_types/profile.ts#L85-L92" + }, + { "kind": "interface", "name": { - "name": "TermsAggregateBase", - "namespace": "_types.aggregations" + "name": "AggregationBreakdown", + "namespace": "_global.search._types" }, "properties": [ { - "name": "doc_count_error_upper_bound", - "required": false, + "name": "build_aggregation", + "required": true, "type": { "kind": "instance_of", "type": { @@ -75792,8 +79770,8 @@ } }, { - "name": "sum_other_doc_count", - "required": false, + "name": "build_aggregation_count", + "required": true, "type": { "kind": "instance_of", "type": { @@ -75801,261 +79779,108 @@ "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L417-L422" - }, - { - "description": "Result of a `terms` aggregation when the field is some kind of whole number like a integer, long, or a date.", - "inherits": { - "generics": [ - { + }, + { + "name": "build_leaf_collector", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "LongTermsBucket", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } } - ], - "type": { - "name": "TermsAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "LongTermsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L439-L444", - "variantName": "lterms" - }, - { - "description": "Result of a `terms` aggregation when the field is some kind of decimal number like a float, double, or distance.", - "inherits": { - "generics": [ - { + }, + { + "name": "build_leaf_collector_count", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "DoubleTermsBucket", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } } - ], - "type": { - "name": "TermsAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "DoubleTermsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L451-L456", - "variantName": "dterms" - }, - { - "description": "Result of a `terms` aggregation when the field is unmapped. `buckets` is always empty.", - "inherits": { - "generics": [ - { + }, + { + "name": "collect", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "Void", - "namespace": "_spec_utils" + "name": "long", + "namespace": "_types" } } - ], - "type": { - "name": "TermsAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "UnmappedTermsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L463-L469", - "variantName": "umterms" - }, - { - "description": "Result of the `rare_terms` aggregation when the field is some kind of whole number like a integer, long, or a date.", - "inherits": { - "generics": [ - { + }, + { + "name": "collect_count", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "LongRareTermsBucket", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "LongRareTermsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L471-L476", - "variantName": "lrareterms" - }, - { - "description": "Result of the `rare_terms` aggregation when the field is a string.", - "inherits": { - "generics": [ - { + }, + { + "name": "initialize", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "StringRareTermsBucket", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "StringRareTermsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L483-L487", - "variantName": "srareterms" - }, - { - "description": "Result of a `rare_terms` aggregation when the field is unmapped. `buckets` is always empty.", - "inherits": { - "generics": [ - { + }, + { + "name": "initialize_count", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "Void", - "namespace": "_spec_utils" + "name": "long", + "namespace": "_types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "UnmappedRareTermsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L493-L499", - "variantName": "umrareterms" - }, - { - "extDocId": "search-aggregations-bucket-multi-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-multi-terms-aggregation.html", - "inherits": { - "generics": [ - { + }, + { + "name": "post_collection", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "MultiTermsBucket", - "namespace": "_types.aggregations" + "name": "long", + "namespace": "_types" } } - ], - "type": { - "name": "TermsAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "MultiTermsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L501-L506", - "variantName": "multi_terms" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "extDocId": "search-aggregations-bucket-missing-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-missing-aggregation.html", - "inherits": { - "type": { - "name": "SingleBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "MissingAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L528-L532", - "variantName": "missing" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ + }, { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "AggregateName", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" - } - } - ], - "meta": { - "description": "Nested aggregations", - "fieldname": "aggregations" - }, + "name": "post_collection_count", + "required": false, "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - ], - "description": "Base type for single-bucket aggregation results that can hold sub-aggregations results.", - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "SingleBucketAggregateBase", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "doc_count", + "name": "reduce", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "reduce_count", "required": true, "type": { "kind": "instance_of", @@ -76065,808 +79890,322 @@ } } } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L516-L526" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "extDocId": "search-aggregations-bucket-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-nested-aggregation.html", - "inherits": { - "type": { - "name": "SingleBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "NestedAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L534-L538", - "variantName": "nested" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "extDocId": "search-aggregations-bucket-reverse-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-reverse-nested-aggregation.html", - "inherits": { - "type": { - "name": "SingleBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "ReverseNestedAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L540-L544", - "variantName": "reverse_nested" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "extDocId": "search-aggregations-bucket-global-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html", - "inherits": { - "type": { - "name": "SingleBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "GlobalAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L546-L550", - "variantName": "global" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "extDocId": "search-aggregations-bucket-filter-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html", - "inherits": { - "type": { - "name": "SingleBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "FilterAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L552-L556", - "variantName": "filter" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "extDocId": "search-aggregations-bucket-children-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-children-aggregation.html", - "inherits": { - "type": { - "name": "SingleBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "ChildrenAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L888-L892", - "variantName": "children" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "extDocId": "search-aggregations-bucket-parent-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-parent-aggregation.html", - "inherits": { - "type": { - "name": "SingleBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "ParentAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L894-L898", - "variantName": "parent" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "inherits": { - "type": { - "name": "SingleBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "SamplerAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L558-L559", - "variantName": "sampler" + ], + "specLocation": "_global/search/_types/profile.ts#L26-L39" }, { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "inherits": { - "type": { - "name": "SingleBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "UnmappedSamplerAggregate", - "namespace": "_types.aggregations" + "name": "AggregationProfileDebug", + "namespace": "_global.search._types" }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L561-L562", - "variantName": "unmapped_sampler" - }, - { - "inherits": { - "generics": [ - { + "properties": [ + { + "name": "segments_with_multi_valued_ords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "GeoHashGridBucket", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "GeoHashGridAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L566-L568", - "variantName": "geohash_grid" - }, - { - "extDocId": "search-aggregations-bucket-geotilegrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geotilegrid-aggregation.html", - "inherits": { - "generics": [ - { + }, + { + "name": "collection_strategy", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "GeoTileGridBucket", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "GeoTileGridAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L574-L579", - "variantName": "geotile_grid" - }, - { - "inherits": { - "generics": [ - { + }, + { + "name": "segments_with_single_valued_ords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "GeoHexGridBucket", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "GeoHexGridAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L585-L586", - "variantName": "geohex_grid" - }, - { - "extDocId": "search-aggregations-bucket-range-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html", - "inherits": { - "generics": [ - { + }, + { + "name": "total_buckets", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "RangeBucket", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "RangeAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L594-L598", - "variantName": "range" - }, - { - "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.", - "extDocId": "search-aggregations-bucket-daterange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html", - "inherits": { - "type": { - "name": "RangeAggregate", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "DateRangeAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L609-L615", - "variantName": "date_range" - }, - { - "description": "Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default.", - "extDocId": "search-aggregations-bucket-geodistance-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html", - "inherits": { - "type": { - "name": "RangeAggregate", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "GeoDistanceAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L617-L622", - "variantName": "geo_distance" - }, - { - "extDocId": "search-aggregations-bucket-iprange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html", - "inherits": { - "generics": [ - { + }, + { + "name": "built_buckets", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IpRangeBucket", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "IpRangeAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L624-L629", - "variantName": "ip_range" - }, - { - "extDocId": "search-aggregations-bucket-ipprefix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-ipprefix-aggregation.html", - "inherits": { - "generics": [ - { + }, + { + "name": "result_strategy", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IpPrefixBucket", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "IpPrefixAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L709-L713", - "variantName": "ip_prefix" - }, - { - "extDocId": "search-aggregations-bucket-filters-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html", - "inherits": { - "generics": [ - { + }, + { + "name": "has_filter", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "FiltersBucket", - "namespace": "_types.aggregations" + "name": "boolean", + "namespace": "_builtins" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "FiltersAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L639-L643", - "variantName": "filters" - }, - { - "extDocId": "search-aggregations-bucket-adjacency-matrix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-adjacency-matrix-aggregation.html", - "inherits": { - "generics": [ - { + }, + { + "name": "delegate", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "AdjacencyMatrixBucket", - "namespace": "_types.aggregations" + "name": "string", + "namespace": "_builtins" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "AdjacencyMatrixAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L647-L652", - "variantName": "adjacency_matrix" - }, - { - "inherits": { - "generics": [ - { + }, + { + "name": "delegate_debug", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SignificantLongTermsBucket", - "namespace": "_types.aggregations" + "name": "AggregationProfileDebug", + "namespace": "_global.search._types" } } - ], - "type": { - "name": "SignificantTermsAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "SignificantLongTermsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L668-L670", - "variantName": "siglterms" - }, - { - "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", - "generics": [ + }, { - "name": "T", - "namespace": "_types.aggregations.SignificantTermsAggregateBase" - } - ], - "inherits": { - "generics": [ - { + "name": "chars_fetched", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "T", - "namespace": "_types.aggregations.SignificantTermsAggregateBase" + "name": "integer", + "namespace": "_types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "SignificantTermsAggregateBase", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "bg_count", + "name": "extract_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "doc_count", + "name": "extract_ns", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L658-L666" - }, - { - "inherits": { - "generics": [ - { + }, + { + "name": "values_fetched", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SignificantStringTermsBucket", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } - ], - "type": { - "name": "SignificantTermsAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "SignificantStringTermsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L682-L684", - "variantName": "sigsterms" - }, - { - "description": "Result of the `significant_terms` aggregation on an unmapped field. `buckets` is always empty.", - "inherits": { - "generics": [ - { + }, + { + "name": "collect_analyzed_ns", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "Void", - "namespace": "_spec_utils" + "name": "integer", + "namespace": "_types" } } - ], - "type": { - "name": "SignificantTermsAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "UnmappedSignificantTermsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L690-L696", - "variantName": "umsigterms" - }, - { - "inherits": { - "generics": [ - { + }, + { + "name": "collect_analyzed_count", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CompositeBucket", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "CompositeAggregate", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "after_key", + "name": "surviving_buckets", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CompositeAggregateKey", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L698-L703", - "variantName": "composite" - }, - { - "inherits": { - "generics": [ - { + }, + { + "name": "ordinals_collectors_used", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "FrequentItemSetsBucket", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "FrequentItemSetsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L722-L723", - "variantName": "frequent_item_sets" - }, - { - "inherits": { - "generics": [ - { + }, + { + "name": "ordinals_collectors_overhead_too_high", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "string_hashing_collectors_used", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "TimeSeriesBucket", - "namespace": "_types.aggregations" + "name": "integer", + "namespace": "_types" } } - ], - "type": { - "name": "MultiBucketAggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "TimeSeriesAggregate", - "namespace": "_types.aggregations" - }, - "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L730-L731", - "variantName": "time_series" - }, - { - "extDocId": "search-aggregations-metrics-scripted-metric-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-scripted-metric-aggregation.html", - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "ScriptedMetricAggregate", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "value", - "required": true, + "name": "numeric_collectors_used", + "required": false, "type": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L739-L745", - "variantName": "scripted_metric" - }, - { - "extDocId": "search-aggregations-metrics-top-hits-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html", - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "TopHitsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "hits", - "required": true, + "name": "empty_collectors_used", + "required": false, "type": { - "generics": [ - { - "kind": "user_defined_value" - } - ], "kind": "instance_of", "type": { - "name": "HitsMetadata", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L747-L753", - "variantName": "top_hits" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ + }, { - "generics": [ - { + "name": "deferred_aggregators", + "required": false, + "type": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - }, - { - "kind": "user_defined_value" } - ], - "meta": { - "description": "Additional data", - "fieldname": "data" - }, + } + }, + { + "name": "segments_with_doc_count_field", + "required": false, "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } - } - ], - "extDocId": "search-aggregations-pipeline-inference-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-inference-bucket-aggregation.html", - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "InferenceAggregate", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "value", + "name": "segments_with_deleted_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldValue", + "name": "integer", "namespace": "_types" } } }, { - "name": "feature_importance", + "name": "filters", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "InferenceFeatureImportance", - "namespace": "_types.aggregations" + "name": "AggregationProfileDelegateDebugFilter", + "namespace": "_global.search._types" } } } }, { - "name": "top_classes", + "name": "segments_counted", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "InferenceTopClassEntry", - "namespace": "_types.aggregations" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "name": "warning", + "name": "segments_collected", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L755-L770", - "variantName": "inference" - }, - { - "kind": "interface", - "name": { - "name": "InferenceFeatureImportance", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "feature_name", - "required": true, + "name": "map_reducer", + "required": false, "type": { "kind": "instance_of", "type": { @@ -76876,434 +80215,415 @@ } }, { - "name": "importance", + "name": "brute_force_used", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } }, { - "name": "classes", + "name": "dynamic_pruning_attempted", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "InferenceClassImportance", - "namespace": "_types.aggregations" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L778-L782" - }, - { - "kind": "interface", - "name": { - "name": "InferenceClassImportance", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "class_name", - "required": true, + "name": "dynamic_pruning_used", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "importance", - "required": true, + "name": "skipped_due_to_no_data", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L784-L787" + "specLocation": "_global/search/_types/profile.ts#L42-L76" }, { "kind": "interface", "name": { - "name": "InferenceTopClassEntry", - "namespace": "_types.aggregations" + "name": "AggregationProfileDelegateDebugFilter", + "namespace": "_global.search._types" }, "properties": [ { - "name": "class_name", - "required": true, + "name": "results_from_metadata", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldValue", + "name": "integer", "namespace": "_types" } } }, { - "name": "class_probability", - "required": true, + "name": "query", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "class_score", - "required": true, + "name": "specialized_for", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "segments_counted_in_constant_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L772-L776" + "specLocation": "_global/search/_types/profile.ts#L78-L83" }, { - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "StringStatsAggregate", - "namespace": "_types.aggregations" + "name": "DfsProfile", + "namespace": "_global.search._types" }, "properties": [ { - "name": "count", - "required": true, + "name": "statistics", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "DfsStatisticsProfile", + "namespace": "_global.search._types" } } }, { - "name": "min_length", - "required": true, + "name": "knn", + "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DfsKnnProfile", + "namespace": "_global.search._types" } - ], - "kind": "union_of" + } } - }, + } + ], + "specLocation": "_global/search/_types/profile.ts#L154-L157" + }, + { + "kind": "interface", + "name": { + "name": "DfsStatisticsProfile", + "namespace": "_global.search._types" + }, + "properties": [ { - "name": "max_length", + "name": "type", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "avg_length", + "name": "description", "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "entropy", - "required": true, + "name": "time", + "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } } }, { - "name": "distribution", - "required": false, + "name": "time_in_nanos", + "required": true, "type": { - "items": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, + "generics": [ { "kind": "instance_of", "type": { - "name": "null", - "namespace": "_builtins" + "name": "UnitNanos", + "namespace": "_types" } } ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "DurationValue", + "namespace": "_types" + } } }, { - "name": "min_length_as_string", - "required": false, + "name": "breakdown", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DfsStatisticsBreakdown", + "namespace": "_global.search._types" } } }, { - "name": "max_length_as_string", + "name": "debug", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "name": "avg_length_as_string", + "name": "children", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DfsStatisticsProfile", + "namespace": "_global.search._types" + } } } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L793-L804", - "variantName": "string_stats" + "specLocation": "_global/search/_types/profile.ts#L159-L167" }, { - "extDocId": "search-aggregations-metrics-boxplot-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-boxplot-aggregation.html", - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "BoxPlotAggregate", - "namespace": "_types.aggregations" + "name": "DfsStatisticsBreakdown", + "namespace": "_global.search._types" }, "properties": [ { - "name": "min", + "name": "collection_statistics", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "name": "max", + "name": "collection_statistics_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "name": "q1", + "name": "create_weight", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "name": "q2", + "name": "create_weight_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "rewrite", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", "namespace": "_types" } } }, { - "name": "q3", + "name": "rewrite_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "name": "lower", + "name": "term_statistics", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "name": "upper", + "name": "term_statistics_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } - }, + } + ], + "specLocation": "_global/search/_types/profile.ts#L170-L179" + }, + { + "kind": "interface", + "name": { + "name": "DfsKnnProfile", + "namespace": "_global.search._types" + }, + "properties": [ { - "name": "min_as_string", + "name": "vector_operations_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "max_as_string", - "required": false, + "name": "query", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "KnnQueryProfileResult", + "namespace": "_global.search._types" + } } } }, { - "name": "q1_as_string", - "required": false, + "name": "rewrite_time", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "q2_as_string", - "required": false, + "name": "collector", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "KnnCollectorResult", + "namespace": "_global.search._types" + } } } - }, + } + ], + "specLocation": "_global/search/_types/profile.ts#L181-L186" + }, + { + "kind": "interface", + "name": { + "name": "KnnQueryProfileResult", + "namespace": "_global.search._types" + }, + "properties": [ { - "name": "q3_as_string", - "required": false, + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { @@ -77313,8 +80633,8 @@ } }, { - "name": "lower_as_string", - "required": false, + "name": "description", + "required": true, "type": { "kind": "instance_of", "type": { @@ -77324,87 +80644,50 @@ } }, { - "name": "upper_as_string", + "name": "time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L806-L825", - "variantName": "boxplot" - }, - { - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "TopMetricsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "top", + "name": "time_in_nanos", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TopMetrics", - "namespace": "_types.aggregations" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitNanos", + "namespace": "_types" + } } + ], + "kind": "instance_of", + "type": { + "name": "DurationValue", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L827-L830", - "variantName": "top_metrics" - }, - { - "kind": "interface", - "name": { - "name": "TopMetrics", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "sort", + "name": "breakdown", "required": true, "type": { - "kind": "array_of", - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "FieldValue", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "KnnQueryProfileBreakdown", + "namespace": "_global.search._types" } } }, { - "name": "metrics", - "required": true, + "name": "debug", + "required": false, "type": { "key": { "kind": "instance_of", @@ -77416,139 +80699,58 @@ "kind": "dictionary_of", "singleKey": false, "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "FieldValue", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "user_defined_value" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L832-L836" - }, - { - "extDocId": "search-aggregations-metrics-ttest-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-ttest-aggregation.html", - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "TTestAggregate", - "namespace": "_types.aggregations" - }, - "properties": [ - { - "name": "value", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } }, { - "name": "value_as_string", + "name": "children", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "KnnQueryProfileResult", + "namespace": "_global.search._types" + } } } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L838-L845", - "variantName": "t_test" + "specLocation": "_global/search/_types/profile.ts#L188-L196" }, { - "extDocId": "search-aggregations-metrics-rate-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-rate-aggregation.html", - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, "kind": "interface", "name": { - "name": "RateAggregate", - "namespace": "_types.aggregations" + "name": "KnnQueryProfileBreakdown", + "namespace": "_global.search._types" }, "properties": [ { - "name": "value", + "name": "advance", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "name": "value_as_string", - "required": false, + "name": "advance_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L847-L854", - "variantName": "rate" - }, - { - "description": "Result of the `cumulative_cardinality` aggregation", - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "CumulativeCardinalityAggregate", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "value", + "name": "build_scorer", "required": true, "type": { "kind": "instance_of", @@ -77559,37 +80761,18 @@ } }, { - "name": "value_as_string", - "required": false, + "name": "build_scorer_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L856-L864", - "variantName": "simple_long_value" - }, - { - "extDocId": "search-aggregations-matrix-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-matrix-stats-aggregation.html", - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "MatrixStatsAggregate", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "doc_count", + "name": "compute_max_score", "required": true, "type": { "kind": "instance_of", @@ -77600,43 +80783,18 @@ } }, { - "name": "fields", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "MatrixStatsFields", - "namespace": "_types.aggregations" - } - } - } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L866-L873", - "variantName": "matrix_stats" - }, - { - "kind": "interface", - "name": { - "name": "MatrixStatsFields", - "namespace": "_types.aggregations" - }, - "properties": [ - { - "name": "name", + "name": "compute_max_score_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "long", "namespace": "_types" } } }, { - "name": "count", + "name": "count_weight", "required": true, "type": { "kind": "instance_of", @@ -77647,318 +80805,248 @@ } }, { - "name": "mean", + "name": "count_weight_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "name": "variance", + "name": "create_weight", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "name": "skewness", + "name": "create_weight_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "name": "kurtosis", + "name": "match", "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "long", "namespace": "_types" } } }, { - "name": "covariance", + "name": "match_count", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "name": "correlation", + "name": "next_doc", "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L875-L884" - }, - { - "extDocId": "search-aggregations-metrics-geo-line", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geo-line.html", - "inherits": { - "type": { - "name": "AggregateBase", - "namespace": "_types.aggregations" - } - }, - "kind": "interface", - "name": { - "name": "GeoLineAggregate", - "namespace": "_types.aggregations" - }, - "properties": [ + }, { - "name": "type", + "name": "next_doc_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "geometry", + "name": "score", "required": true, "type": { "kind": "instance_of", "type": { - "name": "GeoLine", + "name": "long", "namespace": "_types" } } }, { - "name": "properties", + "name": "score_count", "required": true, "type": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - ], - "specLocation": "_types/aggregations/Aggregate.ts#L902-L912", - "variantName": "geo_line" - }, - { - "description": "A GeoJson GeoLine.", - "kind": "interface", - "name": { - "name": "GeoLine", - "namespace": "_types" - }, - "properties": [ + }, { - "description": "Always `\"LineString\"`", - "name": "type", + "name": "set_min_competitive_score", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "description": "Array of `[lon, lat]` coordinates", - "name": "coordinates", + "name": "set_min_competitive_score_count", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "_types/Geo.ts#L56-L62" - }, - { - "kind": "interface", - "name": { - "name": "ClusterStatistics", - "namespace": "_types" - }, - "properties": [ + }, { - "name": "skipped", + "name": "shallow_advance", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "successful", + "name": "shallow_advance_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } - }, + } + ], + "specLocation": "_global/search/_types/profile.ts#L199-L220" + }, + { + "kind": "interface", + "name": { + "name": "KnnCollectorResult", + "namespace": "_global.search._types" + }, + "properties": [ { - "name": "total", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "running", + "name": "reason", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "partial", - "required": true, + "name": "time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Duration", "namespace": "_types" } } }, { - "name": "failed", + "name": "time_in_nanos", "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitNanos", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "integer", + "name": "DurationValue", "namespace": "_types" } } }, { - "name": "details", + "name": "children", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "ClusterAlias", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ClusterDetails", - "namespace": "_types" + "name": "KnnCollectorResult", + "namespace": "_global.search._types" } } } } ], - "specLocation": "_types/Stats.ts#L27-L35" - }, - { - "kind": "type_alias", - "name": { - "name": "ClusterAlias", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L72-L72", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "specLocation": "_global/search/_types/profile.ts#L222-L228" }, { "kind": "interface", "name": { - "name": "ClusterDetails", - "namespace": "_types" + "name": "FetchProfile", + "namespace": "_global.search._types" }, "properties": [ { - "name": "status", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ClusterSearchStatus", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "indices", + "name": "description", "required": true, "type": { "kind": "instance_of", @@ -77969,14 +81057,14 @@ } }, { - "name": "took", - "required": false, + "name": "time_in_nanos", + "required": true, "type": { "generics": [ { "kind": "instance_of", "type": { - "name": "UnitMillis", + "name": "UnitNanos", "namespace": "_types" } } @@ -77989,217 +81077,229 @@ } }, { - "name": "timed_out", + "name": "breakdown", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "FetchProfileBreakdown", + "namespace": "_global.search._types" } } }, { - "name": "_shards", + "name": "debug", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", - "namespace": "_types" + "name": "FetchProfileDebug", + "namespace": "_global.search._types" } } }, { - "name": "failures", + "name": "children", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ShardFailure", - "namespace": "_types" + "name": "FetchProfile", + "namespace": "_global.search._types" } } } } ], - "specLocation": "_types/Stats.ts#L45-L52" - }, - { - "kind": "enum", - "members": [ - { - "name": "running" - }, - { - "name": "successful" - }, - { - "name": "partial" - }, - { - "name": "skipped" - }, - { - "name": "failed" - } - ], - "name": { - "name": "ClusterSearchStatus", - "namespace": "_types" - }, - "specLocation": "_types/Stats.ts#L37-L43" - }, - { - "generics": [ - { - "name": "Unit", - "namespace": "_types.DurationValue" - } - ], - "kind": "type_alias", - "name": { - "name": "DurationValue", - "namespace": "_types" - }, - "specLocation": "_types/Time.ts#L67-L67", - "type": { - "kind": "instance_of", - "type": { - "name": "Unit", - "namespace": "_types.DurationValue" - } - } + "specLocation": "_global/search/_types/profile.ts#L230-L237" }, { "kind": "interface", "name": { - "name": "Profile", + "name": "FetchProfileBreakdown", "namespace": "_global.search._types" }, "properties": [ { - "name": "shards", - "required": true, + "name": "load_source", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardProfile", - "namespace": "_global.search._types" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "_global/search/_types/profile.ts#L101-L103" - }, - { - "kind": "interface", - "name": { - "name": "ShardProfile", - "namespace": "_global.search._types" - }, - "properties": [ + }, { - "name": "aggregations", - "required": true, + "name": "load_source_count", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "AggregationProfile", - "namespace": "_global.search._types" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "name": "cluster", - "required": true, + "name": "load_stored_fields", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "dfs", + "name": "load_stored_fields_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DfsProfile", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "fetch", + "name": "next_reader", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FetchProfile", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "id", - "required": true, + "name": "next_reader_count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "index", - "required": true, + "name": "process_count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "integer", "namespace": "_types" } } }, { - "name": "node_id", - "required": true, + "name": "process", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "_global/search/_types/profile.ts#L239-L248" + }, + { + "kind": "interface", + "name": { + "name": "FetchProfileDebug", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "stored_fields", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "fast_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", "namespace": "_types" } } + } + ], + "specLocation": "_global/search/_types/profile.ts#L250-L253" + }, + { + "kind": "type_alias", + "name": { + "name": "NodeId", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L57-L57", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "interface", + "name": { + "name": "SearchProfile", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "collector", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Collector", + "namespace": "_global.search._types" + } + } + } }, { - "name": "searches", + "name": "query", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "SearchProfile", + "name": "QueryProfile", "namespace": "_global.search._types" } } } }, { - "name": "shard_id", + "name": "rewrite_time", "required": true, "type": { "kind": "instance_of", @@ -78210,28 +81310,28 @@ } } ], - "specLocation": "_global/search/_types/profile.ts#L142-L152" + "specLocation": "_global/search/_types/profile.ts#L136-L140" }, { "kind": "interface", "name": { - "name": "AggregationProfile", + "name": "Collector", "namespace": "_global.search._types" }, "properties": [ { - "name": "breakdown", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "AggregationBreakdown", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "description", + "name": "reason", "required": true, "type": { "kind": "instance_of", @@ -78261,28 +81361,6 @@ } } }, - { - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "debug", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "AggregationProfileDebug", - "namespace": "_global.search._types" - } - } - }, { "name": "children", "required": false, @@ -78291,79 +81369,101 @@ "value": { "kind": "instance_of", "type": { - "name": "AggregationProfile", + "name": "Collector", "namespace": "_global.search._types" } } } } ], - "specLocation": "_global/search/_types/profile.ts#L85-L92" + "specLocation": "_global/search/_types/profile.ts#L94-L99" }, { "kind": "interface", "name": { - "name": "AggregationBreakdown", + "name": "QueryProfile", "namespace": "_global.search._types" }, "properties": [ { - "name": "build_aggregation", + "name": "breakdown", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "QueryBreakdown", + "namespace": "_global.search._types" } } }, { - "name": "build_aggregation_count", + "name": "description", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "build_leaf_collector", + "name": "time_in_nanos", "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitNanos", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "long", + "name": "DurationValue", "namespace": "_types" } } }, { - "name": "build_leaf_collector_count", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "collect", - "required": true, + "name": "children", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryProfile", + "namespace": "_global.search._types" + } } } - }, + } + ], + "specLocation": "_global/search/_types/profile.ts#L128-L134" + }, + { + "kind": "interface", + "name": { + "name": "QueryBreakdown", + "namespace": "_global.search._types" + }, + "properties": [ { - "name": "collect_count", + "name": "advance", "required": true, "type": { "kind": "instance_of", @@ -78374,7 +81474,7 @@ } }, { - "name": "initialize", + "name": "advance_count", "required": true, "type": { "kind": "instance_of", @@ -78385,7 +81485,7 @@ } }, { - "name": "initialize_count", + "name": "build_scorer", "required": true, "type": { "kind": "instance_of", @@ -78396,8 +81496,8 @@ } }, { - "name": "post_collection", - "required": false, + "name": "build_scorer_count", + "required": true, "type": { "kind": "instance_of", "type": { @@ -78407,8 +81507,8 @@ } }, { - "name": "post_collection_count", - "required": false, + "name": "create_weight", + "required": true, "type": { "kind": "instance_of", "type": { @@ -78418,7 +81518,7 @@ } }, { - "name": "reduce", + "name": "create_weight_count", "required": true, "type": { "kind": "instance_of", @@ -78429,7 +81529,7 @@ } }, { - "name": "reduce_count", + "name": "match", "required": true, "type": { "kind": "instance_of", @@ -78438,229 +81538,313 @@ "namespace": "_types" } } - } - ], - "specLocation": "_global/search/_types/profile.ts#L26-L39" - }, - { - "kind": "interface", - "name": { - "name": "AggregationProfileDebug", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "segments_with_multi_valued_ords", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "collection_strategy", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "segments_with_single_valued_ords", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "total_buckets", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } }, { - "name": "built_buckets", - "required": false, + "name": "match_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "result_strategy", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "has_filter", - "required": false, + "name": "shallow_advance", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "delegate", - "required": false, + "name": "shallow_advance_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "delegate_debug", - "required": false, + "name": "next_doc", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "AggregationProfileDebug", - "namespace": "_global.search._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "chars_fetched", - "required": false, + "name": "next_doc_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "extract_count", - "required": false, + "name": "score", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "extract_ns", - "required": false, + "name": "score_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "values_fetched", - "required": false, + "name": "compute_max_score", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "collect_analyzed_ns", - "required": false, + "name": "compute_max_score_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "collect_analyzed_count", - "required": false, + "name": "count_weight", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "surviving_buckets", - "required": false, + "name": "count_weight_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "ordinals_collectors_used", - "required": false, + "name": "set_min_competitive_score", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "ordinals_collectors_overhead_too_high", - "required": false, + "name": "set_min_competitive_score_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } - }, + } + ], + "specLocation": "_global/search/_types/profile.ts#L105-L126" + }, + { + "kind": "type_alias", + "name": { + "name": "ScrollId", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L49-L49", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The suggestion name as returned from the server. Depending whether typed_keys is specified this could come back\nin the form of `name#type` instead of simply `name`", + "kind": "type_alias", + "name": { + "name": "SuggestionName", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L148-L152", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "generics": [ { - "name": "string_hashing_collectors_used", - "required": false, - "type": { + "name": "TDocument", + "namespace": "_global.search._types.Suggest" + } + ], + "kind": "type_alias", + "name": { + "name": "Suggest", + "namespace": "_global.search._types" + }, + "specLocation": "_global/search/_types/suggester.ts#L34-L40", + "type": { + "items": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.search._types.Suggest" + } + } + ], "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "CompletionSuggest", + "namespace": "_global.search._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PhraseSuggest", + "namespace": "_global.search._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TermSuggest", + "namespace": "_global.search._types" } } - }, + ], + "kind": "union_of" + }, + "variants": { + "kind": "external_tag" + } + }, + { + "generics": [ { - "name": "numeric_collectors_used", - "required": false, + "name": "TDocument", + "namespace": "_global.search._types.CompletionSuggest" + } + ], + "inherits": { + "type": { + "name": "SuggestBase", + "namespace": "_global.search._types" + } + }, + "kind": "interface", + "name": { + "name": "CompletionSuggest", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "options", + "required": true, + "type": { + "items": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.search._types.CompletionSuggest" + } + } + ], + "kind": "instance_of", + "type": { + "name": "CompletionSuggestOption", + "namespace": "_global.search._types" + } + }, + { + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.search._types.CompletionSuggest" + } + } + ], + "kind": "instance_of", + "type": { + "name": "CompletionSuggestOption", + "namespace": "_global.search._types" + } + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "_global/search/_types/suggester.ts#L48-L55", + "variantName": "completion" + }, + { + "kind": "interface", + "name": { + "name": "SuggestBase", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "length", + "required": true, "type": { "kind": "instance_of", "type": { @@ -78670,8 +81854,8 @@ } }, { - "name": "empty_collectors_used", - "required": false, + "name": "offset", + "required": true, "type": { "kind": "instance_of", "type": { @@ -78681,166 +81865,240 @@ } }, { - "name": "deferred_aggregators", - "required": false, + "name": "text", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_global/search/_types/suggester.ts#L42-L46" + }, + { + "generics": [ { - "name": "segments_with_doc_count_field", + "name": "TDocument", + "namespace": "_global.search._types.CompletionSuggestOption" + } + ], + "kind": "interface", + "name": { + "name": "CompletionSuggestOption", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "collate_match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "segments_with_deleted_docs", + "name": "contexts", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Context", + "namespace": "_global.search._types" + } + } } } }, { - "name": "filters", + "name": "fields", "required": false, "type": { - "kind": "array_of", - "value": { + "key": { "kind": "instance_of", "type": { - "name": "AggregationProfileDelegateDebugFilter", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "name": "segments_counted", + "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "segments_collected", + "name": "_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "map_reducer", + "name": "_routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Routing", + "namespace": "_types" } } }, { - "name": "brute_force_used", + "name": "_score", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "name": "dynamic_pruning_attempted", + "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TDocument", + "namespace": "_global.search._types.CompletionSuggestOption" } } }, { - "name": "dynamic_pruning_used", - "required": false, + "name": "text", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "skipped_due_to_no_data", + "name": "score", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } } ], - "specLocation": "_global/search/_types/profile.ts#L42-L76" + "specLocation": "_global/search/_types/suggester.ts#L73-L84" }, { + "inherits": { + "type": { + "name": "SuggestBase", + "namespace": "_global.search._types" + } + }, "kind": "interface", "name": { - "name": "AggregationProfileDelegateDebugFilter", + "name": "PhraseSuggest", "namespace": "_global.search._types" }, "properties": [ { - "name": "results_from_metadata", - "required": false, + "name": "options", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "PhraseSuggestOption", + "namespace": "_global.search._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PhraseSuggestOption", + "namespace": "_global.search._types" + } + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "_global/search/_types/suggester.ts#L57-L62", + "variantName": "phrase" + }, + { + "kind": "interface", + "name": { + "name": "PhraseSuggestOption", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "text", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "query", - "required": false, + "name": "score", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "name": "specialized_for", + "name": "highlighted", "required": false, "type": { "kind": "instance_of", @@ -78851,127 +82109,226 @@ } }, { - "name": "segments_counted_in_constant_time", + "name": "collate_match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "_global/search/_types/profile.ts#L78-L83" + "specLocation": "_global/search/_types/suggester.ts#L86-L91" }, { + "inherits": { + "type": { + "name": "SuggestBase", + "namespace": "_global.search._types" + } + }, "kind": "interface", "name": { - "name": "DfsProfile", + "name": "TermSuggest", + "namespace": "_global.search._types" + }, + "properties": [ + { + "name": "options", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "TermSuggestOption", + "namespace": "_global.search._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TermSuggestOption", + "namespace": "_global.search._types" + } + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "_global/search/_types/suggester.ts#L64-L69", + "variantName": "term" + }, + { + "kind": "interface", + "name": { + "name": "TermSuggestOption", "namespace": "_global.search._types" }, "properties": [ { - "name": "statistics", + "name": "text", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "score", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "freq", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "highlighted", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DfsStatisticsProfile", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "knn", + "name": "collate_match", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DfsKnnProfile", - "namespace": "_global.search._types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "_global/search/_types/profile.ts#L154-L157" + "specLocation": "_global/search/_types/suggester.ts#L93-L99" }, { + "description": "The response returned by Elasticsearch when request execution did not succeed.", "kind": "interface", "name": { - "name": "DfsStatisticsProfile", - "namespace": "_global.search._types" + "name": "ErrorResponseBase", + "namespace": "_types" }, "properties": [ { - "name": "type", + "name": "error", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ErrorCause", + "namespace": "_types" } } }, { - "name": "description", + "name": "status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - }, - { - "name": "time", - "required": false, - "type": { + } + ], + "specLocation": "_types/Base.ts#L127-L136" + }, + { + "codegenNames": [ + "header", + "body" + ], + "kind": "type_alias", + "name": { + "name": "RequestItem", + "namespace": "_global.msearch_template" + }, + "specLocation": "_global/msearch_template/types.ts#L25-L26", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "MultisearchHeader", + "namespace": "_global.msearch" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TemplateConfig", + "namespace": "_global.msearch_template" } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "interface", + "name": { + "name": "TemplateConfig", + "namespace": "_global.msearch_template" + }, + "properties": [ { - "name": "time_in_nanos", - "required": true, + "description": "If `true`, returns detailed information about score calculation as part of each hit.", + "name": "explain", + "required": false, + "serverDefault": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "breakdown", - "required": true, + "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.", + "name": "id", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DfsStatisticsBreakdown", - "namespace": "_global.search._types" + "name": "Id", + "namespace": "_types" } } }, { - "name": "debug", + "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", + "name": "params", "required": false, "type": { "key": { @@ -78989,821 +82346,1063 @@ } }, { - "name": "children", + "description": "If `true`, the query execution is profiled.", + "name": "profile", "required": false, + "serverDefault": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DfsStatisticsProfile", - "namespace": "_global.search._types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "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.", + "name": "source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_global/search/_types/profile.ts#L159-L167" + "specLocation": "_global/msearch_template/types.ts#L28-L54" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "description": "The default context if no other context is specified.", + "name": "painless_test" + }, + { + "description": "Treats scripts as if they were run inside a script query.", + "name": "filter" + }, + { + "description": "Treats scripts as if they were run inside a `script_score` function in a `function_score` query.", + "name": "score" + }, + { + "description": "The context for boolean fields. The script returns a `true` or `false` response.", + "name": "boolean_field" + }, + { + "description": "The context for date fields. `emit` takes a long value and the script returns a sorted list of dates.", + "name": "date_field" + }, + { + "description": "The context for double numeric fields. The script returns a sorted list of double values.", + "name": "double_field" + }, + { + "description": "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.", + "name": "geo_point_field" + }, + { + "description": "The context for `ip` fields. The script returns a sorted list of IP addresses.", + "name": "ip_field" + }, + { + "description": "The context for keyword fields. The script returns a sorted list of string values.", + "name": "keyword_field" + }, + { + "description": "The context for long numeric fields. The script returns a sorted list of long values.", + "name": "long_field" + }, + { + "description": "The context for composite runtime fields. The script returns a map of values.", + "name": "composite_field" + } + ], "name": { - "name": "DfsStatisticsBreakdown", + "name": "PainlessContext", + "namespace": "_global.scripts_painless_execute" + }, + "specLocation": "_global/scripts_painless_execute/types.ts#L57-L80" + }, + { + "codegenNames": [ + "fetch", + "fields" + ], + "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.", + "kind": "type_alias", + "name": { + "name": "SourceConfigParam", "namespace": "_global.search._types" }, - "properties": [ - { - "name": "collection_statistics", - "required": true, - "type": { + "specLocation": "_global/search/_types/SourceFilter.ts#L39-L45", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } - } - }, - { - "name": "collection_statistics_count", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", + "name": "Fields", "namespace": "_types" } } + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "Coordinate", + "namespace": "_global.search_mvt._types" + }, + "specLocation": "_global/search_mvt/_types/Coordinate.ts#L22-L22", + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "kind": "enum", + "members": [ + { + "name": "geotile" }, { - "name": "create_weight", - "required": true, - "type": { + "name": "geohex" + } + ], + "name": { + "name": "GridAggregationType", + "namespace": "_global.search_mvt._types" + }, + "specLocation": "_global/search_mvt/_types/GridType.ts#L30-L33" + }, + { + "kind": "enum", + "members": [ + { + "name": "grid" + }, + { + "name": "point" + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "name": "centroid" + } + ], + "name": { + "name": "GridType", + "namespace": "_global.search_mvt._types" + }, + "specLocation": "_global/search_mvt/_types/GridType.ts#L20-L28" + }, + { + "kind": "type_alias", + "name": { + "name": "ZoomLevel", + "namespace": "_global.search_mvt._types" + }, + "specLocation": "_global/search_mvt/_types/ZoomLevel.ts#L22-L22", + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "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.", + "kind": "type_alias", + "name": { + "name": "NullValue", + "namespace": "_spec_utils" + }, + "specLocation": "_spec_utils/utils.ts#L22-L27", + "type": { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + }, + { + "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.", + "generics": [ + { + "name": "T", + "namespace": "_spec_utils.Stringified" + } + ], + "kind": "type_alias", + "name": { + "name": "Stringified", + "namespace": "_spec_utils" + }, + "specLocation": "_spec_utils/Stringified.ts#L20-L27", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "T", + "namespace": "_spec_utils.Stringified" } - } - }, - { - "name": "create_weight_count", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + ], + "kind": "union_of" + } + }, + { + "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", + "kind": "type_alias", + "name": { + "name": "Void", + "namespace": "_spec_utils" + }, + "specLocation": "_spec_utils/VoidValue.ts#L20-L28", + "type": { + "kind": "instance_of", + "type": { + "name": "void", + "namespace": "_builtins" + } + } + }, + { + "description": "`WithNullValue` allows for explicit null assignments in contexts where `null` should be interpreted as an\nactual value.", + "generics": [ { - "name": "rewrite", - "required": true, - "type": { + "name": "T", + "namespace": "_spec_utils.WithNullValue" + } + ], + "kind": "type_alias", + "name": { + "name": "WithNullValue", + "namespace": "_spec_utils" + }, + "specLocation": "_spec_utils/utils.ts#L29-L33", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "T", + "namespace": "_spec_utils.WithNullValue" } - } - }, - { - "name": "rewrite_count", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "NullValue", + "namespace": "_spec_utils" } } - }, - { - "name": "term_statistics", - "required": true, - "type": { + ], + "kind": "union_of" + } + }, + { + "docId": "byte-units", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units", + "kind": "type_alias", + "name": { + "name": "ByteSize", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L90-L91", + "type": { + "items": [ + { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } - } - }, - { - "name": "term_statistics_count", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "codegenName": "bytes", + "name": "b" + }, + { + "codegenName": "kilo_bytes", + "name": "kb" + }, + { + "codegenName": "mega_bytes", + "name": "mb" + }, + { + "codegenName": "giga_bytes", + "name": "gb" + }, + { + "codegenName": "tera_bytes", + "name": "tb" + }, + { + "codegenName": "peta_bytes", + "name": "pb" + } + ], + "name": { + "name": "Bytes", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L166-L178" + }, + { + "kind": "type_alias", + "name": { + "name": "CategoryId", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L52-L52", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "enum", + "members": [ + { + "name": "_all" + }, + { + "name": "http" + }, + { + "name": "ingest" + }, + { + "name": "thread_pool" + }, + { + "name": "script" } ], - "specLocation": "_global/search/_types/profile.ts#L170-L179" + "name": { + "name": "ClusterInfoTarget", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L378-L384" }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "DfsKnnProfile", - "namespace": "_global.search._types" + "name": "ClusterInfoTargets", + "namespace": "_types" }, - "properties": [ - { - "name": "vector_operations_count", - "required": false, - "type": { + "specLocation": "_types/common.ts#L386-L386", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "long", + "name": "ClusterInfoTarget", "namespace": "_types" } - } - }, - { - "name": "query", - "required": true, - "type": { + }, + { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "KnnQueryProfileResult", - "namespace": "_global.search._types" + "name": "ClusterInfoTarget", + "namespace": "_types" } } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ { - "name": "rewrite_time", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "description": "Stop reindexing if there are conflicts.", + "name": "abort" }, { - "name": "collector", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "KnnCollectorResult", - "namespace": "_global.search._types" - } - } - } + "description": "Continue reindexing even if there are conflicts.", + "name": "proceed" } ], - "specLocation": "_global/search/_types/profile.ts#L181-L186" - }, - { - "kind": "interface", "name": { - "name": "KnnQueryProfileResult", - "namespace": "_global.search._types" + "name": "Conflicts", + "namespace": "_types" }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, + "specLocation": "_types/common.ts#L180-L189" + }, + { + "kind": "enum", + "members": [ { - "name": "description", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "standardized" }, { - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "name": "saturated" }, { - "name": "time_in_nanos", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, + "name": "chisquared" + } + ], + "name": { + "name": "DFIIndependenceMeasure", + "namespace": "_types" + }, + "specLocation": "_types/Similarity.ts#L20-L24" + }, + { + "kind": "enum", + "members": [ { - "name": "breakdown", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "KnnQueryProfileBreakdown", - "namespace": "_global.search._types" - } - } + "name": "no" }, { - "name": "debug", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } + "name": "b" }, { - "name": "children", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "KnnQueryProfileResult", - "namespace": "_global.search._types" - } - } - } + "name": "l" } ], - "specLocation": "_global/search/_types/profile.ts#L188-L196" - }, - { - "kind": "interface", "name": { - "name": "KnnQueryProfileBreakdown", - "namespace": "_global.search._types" + "name": "DFRAfterEffect", + "namespace": "_types" }, - "properties": [ - { - "name": "advance", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, + "specLocation": "_types/Similarity.ts#L26-L30" + }, + { + "kind": "enum", + "members": [ { - "name": "advance_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "be" }, { - "name": "build_scorer", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "d" }, { - "name": "build_scorer_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "g" }, { - "name": "compute_max_score", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "if" }, { - "name": "compute_max_score_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "in" }, { - "name": "count_weight", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "ine" }, { - "name": "count_weight_count", - "required": true, - "type": { + "name": "p" + } + ], + "name": { + "name": "DFRBasicModel", + "namespace": "_types" + }, + "specLocation": "_types/Similarity.ts#L32-L40" + }, + { + "kind": "type_alias", + "name": { + "name": "DataStreamName", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L86-L86", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "type_alias", + "name": { + "name": "DataStreamNames", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L88-L88", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "long", + "name": "DataStreamName", "namespace": "_types" } - } - }, - { - "name": "create_weight", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataStreamName", + "namespace": "_types" + } } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "EsqlResult", + "namespace": "_types" + }, + "specLocation": "_types/Binary.ts#L24-L24", + "type": { + "kind": "instance_of", + "type": { + "name": "binary", + "namespace": "_builtins" + } + } + }, + { + "kind": "type_alias", + "name": { + "name": "GrokPattern", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L81-L81", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "enum", + "members": [ { - "name": "create_weight_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "aliases": [ + "GREEN" + ], + "description": "All shards are assigned.", + "name": "green" }, { - "name": "match", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "aliases": [ + "YELLOW" + ], + "description": "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.", + "name": "yellow" }, { - "name": "match_count", - "required": true, + "aliases": [ + "RED" + ], + "description": "One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.", + "name": "red" + } + ], + "name": { + "name": "HealthStatus", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L216-L236" + }, + { + "kind": "type_alias", + "name": { + "name": "Host", + "namespace": "_types" + }, + "specLocation": "_types/Networking.ts#L21-L21", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "type_alias", + "name": { + "name": "HttpHeaders", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L155-L155", + "type": { + "key": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "string", + "namespace": "_builtins" } }, - { - "name": "next_doc", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "dictionary_of", + "singleKey": false, + "value": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - } - }, + ], + "kind": "union_of" + } + } + }, + { + "kind": "enum", + "members": [ { - "name": "next_doc_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "ll" }, { - "name": "score", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "spl" + } + ], + "name": { + "name": "IBDistribution", + "namespace": "_types" + }, + "specLocation": "_types/Similarity.ts#L42-L45" + }, + { + "kind": "enum", + "members": [ + { + "name": "df" }, { - "name": "score_count", - "required": true, + "name": "ttf" + } + ], + "name": { + "name": "IBLambda", + "namespace": "_types" + }, + "specLocation": "_types/Similarity.ts#L47-L50" + }, + { + "kind": "type_alias", + "name": { + "name": "IndexAlias", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L62-L62", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "type_alias", + "name": { + "name": "IndexPattern", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L63-L63", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "type_alias", + "name": { + "name": "IndexPatterns", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L64-L64", + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } + "name": "IndexPattern", + "namespace": "_types" } + } + } + }, + { + "kind": "type_alias", + "name": { + "name": "Ip", + "namespace": "_types" + }, + "specLocation": "_types/Networking.ts#L20-L20", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "enum", + "members": [ + { + "name": "cluster" }, { - "name": "set_min_competitive_score", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "indices" }, { - "name": "set_min_competitive_score_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "shards" + } + ], + "name": { + "name": "Level", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L246-L250" + }, + { + "kind": "enum", + "members": [ + { + "name": "RUNNING" }, { - "name": "shallow_advance", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "STOPPING" }, { - "name": "shallow_advance_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "STOPPED" } ], - "specLocation": "_global/search/_types/profile.ts#L199-L220" + "name": { + "name": "LifecycleOperationMode", + "namespace": "_types" + }, + "specLocation": "_types/Lifecycle.ts#L20-L24" }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "KnnCollectorResult", - "namespace": "_global.search._types" + "name": "MapboxVectorTiles", + "namespace": "_types" }, - "properties": [ - { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "reason", - "required": true, - "type": { + "specLocation": "_types/Binary.ts#L21-L21", + "type": { + "kind": "instance_of", + "type": { + "name": "binary", + "namespace": "_builtins" + } + } + }, + { + "kind": "type_alias", + "name": { + "name": "Metrics", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L70-L70", + "type": { + "items": [ + { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - } - }, - { - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - }, - { - "name": "time_in_nanos", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "Names", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L75-L75", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "Name", "namespace": "_types" } - } - }, - { - "name": "children", - "required": false, - "type": { + }, + { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "KnnCollectorResult", - "namespace": "_global.search._types" + "name": "Name", + "namespace": "_types" } } } + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "Namespace", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L77-L77", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ], - "specLocation": "_global/search/_types/profile.ts#L222-L228" + } }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "FetchProfile", - "namespace": "_global.search._types" + "name": "NodeIds", + "namespace": "_types" }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "description", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "time_in_nanos", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], + "specLocation": "_types/common.ts#L58-L58", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "NodeId", "namespace": "_types" } - } - }, - { - "name": "breakdown", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "FetchProfileBreakdown", - "namespace": "_global.search._types" - } - } - }, - { - "name": "debug", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FetchProfileDebug", - "namespace": "_global.search._types" - } - } - }, - { - "name": "children", - "required": false, - "type": { + }, + { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "FetchProfile", - "namespace": "_global.search._types" + "name": "NodeId", + "namespace": "_types" } } } - } - ], - "specLocation": "_global/search/_types/profile.ts#L230-L237" + ], + "kind": "union_of" + } }, { - "kind": "interface", + "docId": "modules-node", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html", + "kind": "type_alias", "name": { - "name": "FetchProfileBreakdown", - "namespace": "_global.search._types" + "name": "NodeName", + "namespace": "_types" }, - "properties": [ + "specLocation": "_types/common.ts#L83-L84", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "enum", + "members": [ { - "name": "load_source", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "master" }, { - "name": "load_source_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "data" }, { - "name": "load_stored_fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "data_cold" }, { - "name": "load_stored_fields_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "data_content" }, { - "name": "next_reader", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "data_frozen" }, { - "name": "next_reader_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "data_hot" }, { - "name": "process_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "data_warm" }, { - "name": "process", - "required": false, + "name": "client" + }, + { + "name": "ingest" + }, + { + "name": "ml" + }, + { + "name": "voting_only" + }, + { + "name": "transform" + }, + { + "name": "remote_cluster_client" + }, + { + "name": "coordinating_only" + } + ], + "name": { + "name": "NodeRole", + "namespace": "_types" + }, + "specLocation": "_types/Node.ts#L71-L89" + }, + { + "description": "* @doc_id node-roles", + "kind": "type_alias", + "name": { + "name": "NodeRoles", + "namespace": "_types" + }, + "specLocation": "_types/Node.ts#L91-L94", + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "name": "NodeRole", + "namespace": "_types" } } - ], - "specLocation": "_global/search/_types/profile.ts#L239-L248" + } }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "no" + }, + { + "name": "h1" + }, + { + "name": "h2" + }, + { + "name": "h3" + }, + { + "name": "z" + } + ], "name": { - "name": "FetchProfileDebug", - "namespace": "_global.search._types" + "name": "Normalization", + "namespace": "_types" }, - "properties": [ + "specLocation": "_types/Similarity.ts#L52-L58" + }, + { + "kind": "enum", + "members": [ { - "name": "stored_fields", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } + "description": "Overwrite any documents that already exist.", + "name": "index" }, { - "name": "fast_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "description": "Only index documents that do not already exist.", + "name": "create" } ], - "specLocation": "_global/search/_types/profile.ts#L250-L253" + "name": { + "name": "OpType", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L252-L261" }, { "kind": "type_alias", "name": { - "name": "NodeId", + "name": "Password", "namespace": "_types" }, - "specLocation": "_types/common.ts#L57-L57", + "specLocation": "_types/common.ts#L192-L192", "type": { "kind": "instance_of", "type": { @@ -79813,434 +83412,383 @@ } }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "SearchProfile", - "namespace": "_global.search._types" + "name": "Percentage", + "namespace": "_types" }, - "properties": [ - { - "name": "collector", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Collector", - "namespace": "_global.search._types" - } - } - } - }, - { - "name": "query", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryProfile", - "namespace": "_global.search._types" - } + "specLocation": "_types/Numeric.ts#L28-L28", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - } - }, - { - "name": "rewrite_time", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", + "name": "float", "namespace": "_types" } } + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "PipelineName", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L80-L80", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ], - "specLocation": "_global/search/_types/profile.ts#L136-L140" + } }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "Collector", - "namespace": "_global.search._types" + "name": "PropertyName", + "namespace": "_types" }, - "properties": [ - { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, + "specLocation": "_types/common.ts#L127-L127", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "esQuirk": "This is a boolean that evolved into an enum. ES also accepts plain booleans for true and false.", + "kind": "enum", + "members": [ { - "name": "reason", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "true" }, { - "name": "time_in_nanos", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } + "name": "false" }, { - "name": "children", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Collector", - "namespace": "_global.search._types" - } - } - } + "name": "wait_for" } ], - "specLocation": "_global/search/_types/profile.ts#L94-L99" - }, - { - "kind": "interface", "name": { - "name": "QueryProfile", - "namespace": "_global.search._types" + "name": "Refresh", + "namespace": "_types" }, - "properties": [ + "specLocation": "_types/common.ts#L263-L270" + }, + { + "kind": "enum", + "members": [ { - "name": "breakdown", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryBreakdown", - "namespace": "_global.search._types" - } - } + "name": "created" }, { - "name": "description", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "updated" }, { - "name": "time_in_nanos", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } + "name": "deleted" }, { - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "not_found" }, { - "name": "children", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "QueryProfile", - "namespace": "_global.search._types" - } - } - } + "codegenName": "no_op", + "name": "noop" } ], - "specLocation": "_global/search/_types/profile.ts#L128-L134" + "name": { + "name": "Result", + "namespace": "_types" + }, + "specLocation": "_types/Result.ts#L20-L26" }, { - "kind": "interface", + "codegenNames": [ + "long", + "double", + "string", + "boolean", + "null" + ], + "description": "A scalar value.", + "kind": "type_alias", "name": { - "name": "QueryBreakdown", - "namespace": "_global.search._types" + "name": "ScalarValue", + "namespace": "_types" }, - "properties": [ - { - "name": "advance", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "advance_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "build_scorer", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "build_scorer_count", - "required": true, - "type": { + "specLocation": "_types/common.ts#L33-L37", + "type": { + "items": [ + { "kind": "instance_of", "type": { "name": "long", "namespace": "_types" } - } - }, - { - "name": "create_weight", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", + "name": "double", "namespace": "_types" } - } - }, - { - "name": "create_weight_count", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } - } - }, - { - "name": "match", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } - } - }, - { - "name": "match_count", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "null", + "namespace": "_builtins" } } - }, - { - "name": "shallow_advance", - "required": true, - "type": { + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "ScrollIds", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L50-L50", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "long", + "name": "ScrollId", "namespace": "_types" } - } - }, - { - "name": "shallow_advance_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ScrollId", + "namespace": "_types" + } } } - }, - { - "name": "next_doc", - "required": true, - "type": { + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "Service", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L78-L78", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "codegenNames": [ + "value", + "computed" + ], + "description": "Slices configuration used to parallelize a process.", + "kind": "type_alias", + "name": { + "name": "Slices", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L361-L366", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } - } - }, - { - "name": "next_doc_count", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", + "name": "SlicesCalculation", "namespace": "_types" } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ { - "name": "score", - "required": true, - "type": { + "description": "Let Elasticsearch choose a reasonable number for most data streams and indices.", + "name": "auto" + } + ], + "name": { + "name": "SlicesCalculation", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L368-L376" + }, + { + "kind": "type_alias", + "name": { + "name": "StreamResult", + "namespace": "_types" + }, + "specLocation": "_types/Binary.ts#L27-L27", + "type": { + "kind": "instance_of", + "type": { + "name": "binary", + "namespace": "_builtins" + } + } + }, + { + "kind": "type_alias", + "name": { + "name": "TaskId", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L129-L129", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } - } - }, - { - "name": "score_count", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "name": "cpu" }, { - "name": "compute_max_score", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "wait" }, { - "name": "compute_max_score_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "block" }, { - "name": "count_weight", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "gpu" }, { - "name": "count_weight_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "name": "mem" + } + ], + "name": { + "name": "ThreadType", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L294-L300" + }, + { + "description": "Time of day, expressed as HH:MM:SS", + "kind": "type_alias", + "name": { + "name": "TimeOfDay", + "namespace": "_types" + }, + "specLocation": "_types/Time.ts#L44-L45", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "enum", + "members": [ + { + "codegenName": "nanoseconds", + "name": "nanos" }, { - "name": "set_min_competitive_score", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "codegenName": "microseconds", + "name": "micros" }, { - "name": "set_min_competitive_score_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "codegenName": "milliseconds", + "name": "ms" + }, + { + "codegenName": "seconds", + "name": "s" + }, + { + "codegenName": "minutes", + "name": "m" + }, + { + "codegenName": "hours", + "name": "h" + }, + { + "codegenName": "days", + "name": "d" } ], - "specLocation": "_global/search/_types/profile.ts#L105-L126" + "name": { + "name": "TimeUnit", + "namespace": "_types" + }, + "specLocation": "_types/Time.ts#L69-L77" }, { "kind": "type_alias", "name": { - "name": "ScrollId", + "name": "TransportAddress", "namespace": "_types" }, - "specLocation": "_types/common.ts#L49-L49", + "specLocation": "_types/Networking.ts#L22-L22", "type": { "kind": "instance_of", "type": { @@ -80250,13 +83798,76 @@ } }, { - "description": "The suggestion name as returned from the server. Depending whether typed_keys is specified this could come back\nin the form of `name#type` instead of simply `name`", + "description": "Time unit for fractional milliseconds", "kind": "type_alias", "name": { - "name": "SuggestionName", + "name": "UnitFloatMillis", "namespace": "_types" }, - "specLocation": "_types/common.ts#L148-L152", + "specLocation": "_types/Time.ts#L37-L38", + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "description": "Time unit for milliseconds", + "kind": "type_alias", + "name": { + "name": "UnitMillis", + "namespace": "_types" + }, + "specLocation": "_types/Time.ts#L33-L34", + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Time unit for nanoseconds", + "kind": "type_alias", + "name": { + "name": "UnitNanos", + "namespace": "_types" + }, + "specLocation": "_types/Time.ts#L35-L36", + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Time unit for seconds", + "kind": "type_alias", + "name": { + "name": "UnitSeconds", + "namespace": "_types" + }, + "specLocation": "_types/Time.ts#L29-L30", + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "kind": "type_alias", + "name": { + "name": "Username", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L191-L191", "type": { "kind": "instance_of", "type": { @@ -80266,2681 +83877,3053 @@ } }, { - "generics": [ + "kind": "type_alias", + "name": { + "name": "Uuid", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L122-L122", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "type_alias", + "name": { + "name": "VersionString", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L98-L98", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "kind": "enum", + "members": [ { - "name": "TDocument", - "namespace": "_global.search._types.Suggest" + "name": "all" + }, + { + "name": "index-setting" } ], + "name": { + "name": "WaitForActiveShardOptions", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L302-L306" + }, + { + "codegenNames": [ + "count", + "option" + ], "kind": "type_alias", "name": { - "name": "Suggest", - "namespace": "_global.search._types" + "name": "WaitForActiveShards", + "namespace": "_types" }, - "specLocation": "_global/search/_types/suggester.ts#L34-L40", + "specLocation": "_types/common.ts#L139-L140", "type": { "items": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.search._types.Suggest" - } - } - ], - "kind": "instance_of", - "type": { - "name": "CompletionSuggest", - "namespace": "_global.search._types" - } - }, { "kind": "instance_of", "type": { - "name": "PhraseSuggest", - "namespace": "_global.search._types" + "name": "integer", + "namespace": "_types" } }, { "kind": "instance_of", "type": { - "name": "TermSuggest", - "namespace": "_global.search._types" + "name": "WaitForActiveShardOptions", + "namespace": "_types" } } ], "kind": "union_of" - }, - "variants": { - "kind": "external_tag" } }, { - "generics": [ + "kind": "enum", + "members": [ { - "name": "TDocument", - "namespace": "_global.search._types.CompletionSuggest" + "name": "immediate" + }, + { + "name": "urgent" + }, + { + "name": "high" + }, + { + "name": "normal" + }, + { + "name": "low" + }, + { + "name": "languid" } ], - "inherits": { + "name": { + "name": "WaitForEvents", + "namespace": "_types" + }, + "specLocation": "_types/common.ts#L308-L315" + }, + { + "kind": "type_alias", + "name": { + "name": "byte", + "namespace": "_types" + }, + "specLocation": "_types/Numeric.ts#L21-L21", + "type": { + "kind": "instance_of", "type": { - "name": "SuggestBase", - "namespace": "_global.search._types" + "name": "number", + "namespace": "_builtins" } + } + }, + { + "kind": "type_alias", + "name": { + "name": "short", + "namespace": "_types" }, - "kind": "interface", + "specLocation": "_types/Numeric.ts#L20-L20", + "type": { + "kind": "instance_of", + "type": { + "name": "number", + "namespace": "_builtins" + } + } + }, + { + "kind": "type_alias", "name": { - "name": "CompletionSuggest", - "namespace": "_global.search._types" + "name": "ulong", + "namespace": "_types" }, - "properties": [ - { - "name": "options", - "required": true, - "type": { - "items": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.search._types.CompletionSuggest" - } - } - ], - "kind": "instance_of", - "type": { - "name": "CompletionSuggestOption", - "namespace": "_global.search._types" - } - }, - { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "_global.search._types.CompletionSuggest" - } - } - ], - "kind": "instance_of", - "type": { - "name": "CompletionSuggestOption", - "namespace": "_global.search._types" - } - } - } - ], - "kind": "union_of" - } + "specLocation": "_types/Numeric.ts#L25-L25", + "type": { + "kind": "instance_of", + "type": { + "name": "number", + "namespace": "_builtins" } - ], - "specLocation": "_global/search/_types/suggester.ts#L48-L55", - "variantName": "completion" + } }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "SuggestBase", - "namespace": "_global.search._types" + "name": "Analyzer", + "namespace": "_types.analysis" }, - "properties": [ - { - "name": "length", - "required": true, - "type": { + "specLocation": "_types/analysis/analyzers.ts#L427-L480", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "CustomAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "FingerprintAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "KeywordAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NoriAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PatternAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SimpleAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StandardAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StopAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "WhitespaceAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IcuAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "KuromojiAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SnowballAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ArabicAnalyzer", + "namespace": "_types.analysis" + } + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "ArmenianAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "offset", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "BasqueAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "text", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "BengaliAnalyzer", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L42-L46" - }, - { - "generics": [ - { - "name": "TDocument", - "namespace": "_global.search._types.CompletionSuggestOption" - } - ], - "kind": "interface", - "name": { - "name": "CompletionSuggestOption", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "collate_match", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "BrazilianAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "contexts", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Context", - "namespace": "_global.search._types" - } - } + }, + { + "kind": "instance_of", + "type": { + "name": "BulgarianAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + }, + { + "kind": "instance_of", + "type": { + "name": "CatalanAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "_id", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ChineseAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "_index", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "CjkAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "_routing", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "CzechAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "_score", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "DanishAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "_source", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "TDocument", - "namespace": "_global.search._types.CompletionSuggestOption" + "name": "DutchAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "text", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "EnglishAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "score", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "EstonianAnalyzer", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L73-L84" - }, - { - "inherits": { - "type": { - "name": "SuggestBase", - "namespace": "_global.search._types" - } - }, - "kind": "interface", - "name": { - "name": "PhraseSuggest", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "options", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "PhraseSuggestOption", - "namespace": "_global.search._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "PhraseSuggestOption", - "namespace": "_global.search._types" - } - } - } - ], - "kind": "union_of" - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L57-L62", - "variantName": "phrase" - }, - { - "kind": "interface", - "name": { - "name": "PhraseSuggestOption", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "text", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "FinnishAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "score", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "FrenchAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "highlighted", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "GalicianAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "collate_match", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "GermanAnalyzer", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L86-L91" - }, - { - "inherits": { - "type": { - "name": "SuggestBase", - "namespace": "_global.search._types" - } - }, - "kind": "interface", - "name": { - "name": "TermSuggest", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "options", - "required": true, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "TermSuggestOption", - "namespace": "_global.search._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TermSuggestOption", - "namespace": "_global.search._types" - } - } - } - ], - "kind": "union_of" - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L64-L69", - "variantName": "term" - }, - { - "kind": "interface", - "name": { - "name": "TermSuggestOption", - "namespace": "_global.search._types" - }, - "properties": [ - { - "name": "text", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "GreekAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "score", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "HindiAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "freq", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "HungarianAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "highlighted", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndonesianAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "collate_match", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IrishAnalyzer", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_global/search/_types/suggester.ts#L93-L99" - }, - { - "description": "The response returned by Elasticsearch when request execution did not succeed.", - "kind": "interface", - "name": { - "name": "ErrorResponseBase", - "namespace": "_types" - }, - "properties": [ - { - "name": "error", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "ErrorCause", - "namespace": "_types" + "name": "ItalianAnalyzer", + "namespace": "_types.analysis" } - } - }, - { - "name": "status", - "required": true, - "type": { + }, + { + "kind": "instance_of", + "type": { + "name": "LatvianAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "LithuanianAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NorwegianAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PersianAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PortugueseAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RomanianAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RussianAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SerbianAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SoraniAnalyzer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SpanishAnalyzer", + "namespace": "_types.analysis" + } + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "SwedishAnalyzer", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/Base.ts#L127-L136" - }, - { - "codegenNames": [ - "header", - "body" - ], - "kind": "type_alias", - "name": { - "name": "RequestItem", - "namespace": "_global.msearch_template" - }, - "specLocation": "_global/msearch_template/types.ts#L25-L26", - "type": { - "items": [ + }, { "kind": "instance_of", "type": { - "name": "MultisearchHeader", - "namespace": "_global.msearch" + "name": "TurkishAnalyzer", + "namespace": "_types.analysis" } }, { "kind": "instance_of", "type": { - "name": "TemplateConfig", - "namespace": "_global.msearch_template" + "name": "ThaiAnalyzer", + "namespace": "_types.analysis" } } ], "kind": "union_of" + }, + "variants": { + "defaultTag": "custom", + "kind": "internal_tag", + "nonExhaustive": true, + "tag": "type" } }, { "kind": "interface", "name": { - "name": "TemplateConfig", - "namespace": "_global.msearch_template" + "name": "CustomAnalyzer", + "namespace": "_types.analysis" }, "properties": [ { - "description": "If `true`, returns detailed information about score calculation as part of each hit.", - "name": "explain", - "required": false, - "serverDefault": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "custom" } }, { - "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.", - "name": "id", + "name": "char_filter", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" } }, { - "description": "Key-value pairs used to replace Mustache variables in the template.\nThe key is the variable name.\nThe value is the variable value.", - "name": "params", + "name": "filter", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } + ], + "kind": "union_of" } }, { - "description": "If `true`, the query execution is profiled.", - "name": "profile", + "name": "position_increment_gap", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "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.", - "name": "source", + "name": "position_offset_gap", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "_global/msearch_template/types.ts#L28-L54" - }, - { - "kind": "enum", - "members": [ - { - "description": "The default context if no other context is specified.", - "name": "painless_test" - }, - { - "description": "Treats scripts as if they were run inside a script query.", - "name": "filter" - }, - { - "description": "Treats scripts as if they were run inside a `script_score` function in a `function_score` query.", - "name": "score" - }, - { - "description": "The context for boolean fields. The script returns a `true` or `false` response.", - "name": "boolean_field" - }, - { - "description": "The context for date fields. `emit` takes a long value and the script returns a sorted list of dates.", - "name": "date_field" - }, - { - "description": "The context for double numeric fields. The script returns a sorted list of double values.", - "name": "double_field" - }, - { - "description": "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.", - "name": "geo_point_field" - }, - { - "description": "The context for `ip` fields. The script returns a sorted list of IP addresses.", - "name": "ip_field" - }, - { - "description": "The context for keyword fields. The script returns a sorted list of string values.", - "name": "keyword_field" - }, - { - "description": "The context for long numeric fields. The script returns a sorted list of long values.", - "name": "long_field" }, { - "description": "The context for composite runtime fields. The script returns a map of values.", - "name": "composite_field" - } - ], - "name": { - "name": "PainlessContext", - "namespace": "_global.scripts_painless_execute" - }, - "specLocation": "_global/scripts_painless_execute/types.ts#L57-L80" - }, - { - "codegenNames": [ - "fetch", - "fields" - ], - "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.", - "kind": "type_alias", - "name": { - "name": "SourceConfigParam", - "namespace": "_global.search._types" - }, - "specLocation": "_global/search/_types/SourceFilter.ts#L39-L45", - "type": { - "items": [ - { + "name": "tokenizer", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "Coordinate", - "namespace": "_global.search_mvt._types" - }, - "specLocation": "_global/search_mvt/_types/Coordinate.ts#L22-L22", - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" } - } + ], + "specLocation": "_types/analysis/analyzers.ts#L28-L35" }, { - "kind": "enum", - "members": [ - { - "name": "geotile" - }, - { - "name": "geohex" - } - ], + "kind": "interface", "name": { - "name": "GridAggregationType", - "namespace": "_global.search_mvt._types" + "name": "FingerprintAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_global/search_mvt/_types/GridType.ts#L30-L33" - }, - { - "kind": "enum", - "members": [ - { - "name": "grid" - }, + "properties": [ { - "name": "point" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "fingerprint" + } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "name": "centroid" - } - ], - "name": { - "name": "GridType", - "namespace": "_global.search_mvt._types" - }, - "specLocation": "_global/search_mvt/_types/GridType.ts#L20-L28" - }, - { - "kind": "type_alias", - "name": { - "name": "ZoomLevel", - "namespace": "_global.search_mvt._types" - }, - "specLocation": "_global/search_mvt/_types/ZoomLevel.ts#L22-L22", - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "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.", - "kind": "type_alias", - "name": { - "name": "NullValue", - "namespace": "_spec_utils" - }, - "specLocation": "_spec_utils/utils.ts#L22-L27", - "type": { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - }, - { - "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.", - "generics": [ - { - "name": "T", - "namespace": "_spec_utils.Stringified" - } - ], - "kind": "type_alias", - "name": { - "name": "Stringified", - "namespace": "_spec_utils" - }, - "specLocation": "_spec_utils/Stringified.ts#L20-L27", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "T", - "namespace": "_spec_utils.Stringified" - } + "deprecation": { + "description": "", + "version": "7.14.0" }, - { + "name": "version", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } - ], - "kind": "union_of" - } - }, - { - "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", - "kind": "type_alias", - "name": { - "name": "Void", - "namespace": "_spec_utils" - }, - "specLocation": "_spec_utils/VoidValue.ts#L20-L28", - "type": { - "kind": "instance_of", - "type": { - "name": "void", - "namespace": "_builtins" - } - } - }, - { - "description": "`WithNullValue` allows for explicit null assignments in contexts where `null` should be interpreted as an\nactual value.", - "generics": [ + }, { - "name": "T", - "namespace": "_spec_utils.WithNullValue" - } - ], - "kind": "type_alias", - "name": { - "name": "WithNullValue", - "namespace": "_spec_utils" - }, - "specLocation": "_spec_utils/utils.ts#L29-L33", - "type": { - "items": [ - { + "description": "The maximum token size to emit. Tokens larger than this size will be discarded.\nDefaults to `255`", + "name": "max_output_size", + "required": false, + "serverDefault": 255, + "type": { "kind": "instance_of", "type": { - "name": "T", - "namespace": "_spec_utils.WithNullValue" + "name": "integer", + "namespace": "_types" } - }, - { + } + }, + { + "description": "The character to use to concatenate the terms.\nDefaults to a space.", + "name": "separator", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "NullValue", - "namespace": "_spec_utils" + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "docId": "byte-units", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units", - "kind": "type_alias", - "name": { - "name": "ByteSize", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L90-L91", - "type": { - "items": [ - { + }, + { + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", + "name": "stopwords", + "required": false, + "serverDefault": "_none_", + "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "StopWords", + "namespace": "_types.analysis" } - }, - { + } + }, + { + "description": "The path to a file containing stop words.", + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ - { - "codegenName": "bytes", - "name": "b" - }, - { - "codegenName": "kilo_bytes", - "name": "kb" - }, - { - "codegenName": "mega_bytes", - "name": "mb" - }, - { - "codegenName": "giga_bytes", - "name": "gb" - }, - { - "codegenName": "tera_bytes", - "name": "tb" - }, - { - "codegenName": "peta_bytes", - "name": "pb" } ], - "name": { - "name": "Bytes", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L166-L178" + "specLocation": "_types/analysis/analyzers.ts#L37-L64" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "CategoryId", - "namespace": "_types" + "name": "KeywordAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L52-L52", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "kind": "enum", - "members": [ - { - "name": "_all" - }, - { - "name": "http" - }, - { - "name": "ingest" - }, + "properties": [ { - "name": "thread_pool" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "keyword" + } }, { - "name": "script" + "deprecation": { + "description": "", + "version": "7.14.0" + }, + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } } ], - "name": { - "name": "ClusterInfoTarget", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L378-L384" + "specLocation": "_types/analysis/analyzers.ts#L66-L70" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "ClusterInfoTargets", - "namespace": "_types" + "name": "NoriAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L386-L386", - "type": { - "items": [ - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "nori" + } + }, + { + "deprecation": { + "description": "", + "version": "7.14.0" + }, + "name": "version", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ClusterInfoTarget", + "name": "VersionString", "namespace": "_types" } - }, - { + } + }, + { + "name": "decompound_mode", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NoriDecompoundMode", + "namespace": "_types.analysis" + } + } + }, + { + "name": "stoptags", + "required": false, + "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ClusterInfoTarget", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ - { - "description": "Stop reindexing if there are conflicts.", - "name": "abort" }, { - "description": "Continue reindexing even if there are conflicts.", - "name": "proceed" + "name": "user_dictionary", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "Conflicts", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L180-L189" + "specLocation": "_types/analysis/analyzers.ts#L323-L330" }, { "kind": "enum", "members": [ { - "name": "standardized" + "name": "discard" }, { - "name": "saturated" + "name": "none" }, { - "name": "chisquared" + "name": "mixed" } ], "name": { - "name": "DFIIndependenceMeasure", - "namespace": "_types" + "name": "NoriDecompoundMode", + "namespace": "_types.analysis" }, - "specLocation": "_types/Similarity.ts#L20-L24" + "specLocation": "_types/analysis/nori-plugin.ts#L22-L26" }, { - "kind": "enum", - "members": [ - { - "name": "no" - }, - { - "name": "b" - }, - { - "name": "l" - } - ], + "kind": "interface", "name": { - "name": "DFRAfterEffect", - "namespace": "_types" + "name": "PatternAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/Similarity.ts#L26-L30" - }, - { - "kind": "enum", - "members": [ + "properties": [ { - "name": "be" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "pattern" + } }, { - "name": "d" + "deprecation": { + "description": "", + "version": "7.14.0" + }, + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } }, { - "name": "g" + "description": "Java regular expression flags. Flags should be pipe-separated, eg \"CASE_INSENSITIVE|COMMENTS\".", + "name": "flags", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "if" + "description": "Should terms be lowercased or not.\nDefaults to `true`.", + "name": "lowercase", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "name": "in" + "description": "A Java regular expression.\nDefaults to `\\W+`.", + "name": "pattern", + "required": false, + "serverDefault": "\\W+", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "ine" + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", + "name": "stopwords", + "required": false, + "serverDefault": "_none_", + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } }, { - "name": "p" + "description": "The path to a file containing stop words.", + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "DFRBasicModel", - "namespace": "_types" - }, - "specLocation": "_types/Similarity.ts#L32-L40" + "specLocation": "_types/analysis/analyzers.ts#L332-L365" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "DataStreamName", - "namespace": "_types" + "name": "SimpleAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L86-L86", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "simple" + } + }, + { + "deprecation": { + "description": "", + "version": "7.14.0" + }, + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } } - } + ], + "specLocation": "_types/analysis/analyzers.ts#L367-L371" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "DataStreamNames", - "namespace": "_types" + "name": "StandardAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L88-L88", - "type": { - "items": [ - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "standard" + } + }, + { + "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`.", + "name": "max_token_length", + "required": false, + "serverDefault": 255, + "type": { "kind": "instance_of", "type": { - "name": "DataStreamName", + "name": "integer", "namespace": "_types" } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataStreamName", - "namespace": "_types" - } + } + }, + { + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", + "name": "stopwords", + "required": false, + "serverDefault": "_none_", + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } + }, + { + "description": "The path to a file containing stop words.", + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "EsqlResult", - "namespace": "_types" - }, - "specLocation": "_types/Binary.ts#L24-L24", - "type": { - "kind": "instance_of", - "type": { - "name": "binary", - "namespace": "_builtins" } - } + ], + "specLocation": "_types/analysis/analyzers.ts#L382-L402" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "GrokPattern", - "namespace": "_types" + "name": "StopAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L81-L81", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "kind": "enum", - "members": [ + "properties": [ { - "aliases": [ - "GREEN" - ], - "description": "All shards are assigned.", - "name": "green" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "stop" + } }, { - "aliases": [ - "YELLOW" - ], - "description": "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.", - "name": "yellow" + "deprecation": { + "description": "", + "version": "7.14.0" + }, + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } }, { - "aliases": [ - "RED" - ], - "description": "One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.", - "name": "red" + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", + "name": "stopwords", + "required": false, + "serverDefault": "_none_", + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } + }, + { + "description": "The path to a file containing stop words.", + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "HealthStatus", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L216-L236" + "specLocation": "_types/analysis/analyzers.ts#L404-L419" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "Host", - "namespace": "_types" + "name": "WhitespaceAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/Networking.ts#L21-L21", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "whitespace" + } + }, + { + "deprecation": { + "description": "", + "version": "7.14.0" + }, + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionString", + "namespace": "_types" + } + } } - } + ], + "specLocation": "_types/analysis/analyzers.ts#L421-L425" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "HttpHeaders", - "namespace": "_types" + "name": "IcuAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L155-L155", - "type": { - "key": { - "kind": "instance_of", + "properties": [ + { + "name": "type", + "required": true, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "literal_value", + "value": "icu_analyzer" } }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + { + "name": "method", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationType", + "namespace": "_types.analysis" } - ], - "kind": "union_of" + } + }, + { + "name": "mode", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationMode", + "namespace": "_types.analysis" + } + } } - } + ], + "specLocation": "_types/analysis/icu-plugin.ts#L67-L71" }, { "kind": "enum", "members": [ { - "name": "ll" + "name": "nfc" }, { - "name": "spl" + "name": "nfkc" + }, + { + "name": "nfkc_cf" } ], "name": { - "name": "IBDistribution", - "namespace": "_types" + "name": "IcuNormalizationType", + "namespace": "_types.analysis" }, - "specLocation": "_types/Similarity.ts#L42-L45" + "specLocation": "_types/analysis/icu-plugin.ts#L83-L87" }, { "kind": "enum", "members": [ { - "name": "df" + "name": "decompose" }, { - "name": "ttf" + "name": "compose" } ], "name": { - "name": "IBLambda", - "namespace": "_types" - }, - "specLocation": "_types/Similarity.ts#L47-L50" - }, - { - "kind": "type_alias", - "name": { - "name": "IndexAlias", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L62-L62", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "kind": "type_alias", - "name": { - "name": "IndexPattern", - "namespace": "_types" + "name": "IcuNormalizationMode", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L63-L63", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "specLocation": "_types/analysis/icu-plugin.ts#L78-L81" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "IndexPatterns", - "namespace": "_types" + "name": "KuromojiAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L64-L64", - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", + "properties": [ + { + "name": "type", + "required": true, "type": { - "name": "IndexPattern", - "namespace": "_types" + "kind": "literal_value", + "value": "kuromoji" } - } - } - }, - { - "kind": "type_alias", - "name": { - "name": "Ip", - "namespace": "_types" - }, - "specLocation": "_types/Networking.ts#L20-L20", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "kind": "enum", - "members": [ - { - "name": "cluster" }, { - "name": "indices" + "name": "mode", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "KuromojiTokenizationMode", + "namespace": "_types.analysis" + } + } }, { - "name": "shards" + "name": "user_dictionary", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "Level", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L246-L250" + "specLocation": "_types/analysis/kuromoji-plugin.ts#L25-L29" }, { "kind": "enum", "members": [ { - "name": "RUNNING" + "name": "normal" }, { - "name": "STOPPING" + "name": "search" }, { - "name": "STOPPED" + "name": "extended" } ], "name": { - "name": "LifecycleOperationMode", - "namespace": "_types" - }, - "specLocation": "_types/Lifecycle.ts#L20-L24" - }, - { - "kind": "type_alias", - "name": { - "name": "MapboxVectorTiles", - "namespace": "_types" + "name": "KuromojiTokenizationMode", + "namespace": "_types.analysis" }, - "specLocation": "_types/Binary.ts#L21-L21", - "type": { - "kind": "instance_of", - "type": { - "name": "binary", - "namespace": "_builtins" - } - } + "specLocation": "_types/analysis/kuromoji-plugin.ts#L52-L56" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "Metrics", - "namespace": "_types" + "name": "SnowballAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L70-L70", - "type": { - "items": [ - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "snowball" + } + }, + { + "deprecation": { + "description": "", + "version": "7.14.0" + }, + "name": "version", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "VersionString", + "namespace": "_types" } } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "Names", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L75-L75", - "type": { - "items": [ - { + }, + { + "name": "language", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } + "name": "SnowballLanguage", + "namespace": "_types.analysis" } } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "Namespace", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L77-L77", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "kind": "type_alias", - "name": { - "name": "NodeIds", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L58-L58", - "type": { - "items": [ - { + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "NodeId", - "namespace": "_types" - } + "name": "StopWords", + "namespace": "_types.analysis" } } - ], - "kind": "union_of" - } - }, - { - "docId": "modules-node", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html", - "kind": "type_alias", - "name": { - "name": "NodeName", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L83-L84", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" } - } + ], + "specLocation": "_types/analysis/analyzers.ts#L374-L380" }, { "kind": "enum", "members": [ { - "name": "master" + "name": "Armenian" }, { - "name": "data" + "name": "Basque" }, { - "name": "data_cold" + "name": "Catalan" }, { - "name": "data_content" + "name": "Danish" }, { - "name": "data_frozen" + "name": "Dutch" }, { - "name": "data_hot" + "name": "English" }, { - "name": "data_warm" + "name": "Finnish" }, { - "name": "client" + "name": "French" }, { - "name": "ingest" + "name": "German" }, { - "name": "ml" + "name": "German2" }, { - "name": "voting_only" + "name": "Hungarian" }, { - "name": "transform" + "name": "Italian" }, { - "name": "remote_cluster_client" + "name": "Kp" }, { - "name": "coordinating_only" - } - ], - "name": { - "name": "NodeRole", - "namespace": "_types" - }, - "specLocation": "_types/Node.ts#L71-L89" - }, - { - "description": "* @doc_id node-roles", - "kind": "type_alias", - "name": { - "name": "NodeRoles", - "namespace": "_types" - }, - "specLocation": "_types/Node.ts#L91-L94", - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "NodeRole", - "namespace": "_types" - } - } - } - }, - { - "kind": "enum", - "members": [ + "name": "Lovins" + }, { - "name": "no" + "name": "Norwegian" }, { - "name": "h1" + "name": "Porter" }, { - "name": "h2" + "name": "Portuguese" }, { - "name": "h3" + "name": "Romanian" }, { - "name": "z" - } - ], - "name": { - "name": "Normalization", - "namespace": "_types" - }, - "specLocation": "_types/Similarity.ts#L52-L58" - }, - { - "kind": "enum", - "members": [ + "name": "Russian" + }, { - "description": "Overwrite any documents that already exist.", - "name": "index" + "name": "Spanish" }, { - "description": "Only index documents that do not already exist.", - "name": "create" + "name": "Swedish" + }, + { + "name": "Turkish" } ], "name": { - "name": "OpType", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L252-L261" - }, - { - "kind": "type_alias", - "name": { - "name": "Password", - "namespace": "_types" + "name": "SnowballLanguage", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L192-L192", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "specLocation": "_types/analysis/languages.ts#L20-L43" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "Percentage", - "namespace": "_types" + "name": "ArabicAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/Numeric.ts#L28-L28", - "type": { - "items": [ - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "arabic" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "StopWords", + "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "PipelineName", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L80-L80", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "kind": "type_alias", - "name": { - "name": "PropertyName", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L127-L127", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "esQuirk": "This is a boolean that evolved into an enum. ES also accepts plain booleans for true and false.", - "kind": "enum", - "members": [ - { - "name": "true" - }, - { - "name": "false" - }, - { - "name": "wait_for" - } - ], - "name": { - "name": "Refresh", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L263-L270" - }, - { - "kind": "enum", - "members": [ - { - "name": "created" - }, - { - "name": "updated" - }, - { - "name": "deleted" - }, - { - "name": "not_found" }, { - "codegenName": "no_op", - "name": "noop" + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } } ], - "name": { - "name": "Result", - "namespace": "_types" - }, - "specLocation": "_types/Result.ts#L20-L26" + "specLocation": "_types/analysis/analyzers.ts#L72-L77" }, { - "codegenNames": [ - "long", - "double", - "string", - "boolean", - "null" - ], - "description": "A scalar value.", - "kind": "type_alias", + "kind": "interface", "name": { - "name": "ScalarValue", - "namespace": "_types" + "name": "ArmenianAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L33-L37", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - }, - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "armenian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "StopWords", + "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - ], - "kind": "union_of" - } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L79-L84" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "ScrollIds", - "namespace": "_types" + "name": "BasqueAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L50-L50", - "type": { - "items": [ - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "basque" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ScrollId", - "namespace": "_types" + "name": "StopWords", + "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ScrollId", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "Service", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L78-L78", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" } - } + ], + "specLocation": "_types/analysis/analyzers.ts#L86-L91" }, { - "codegenNames": [ - "value", - "computed" - ], - "description": "Slices configuration used to parallelize a process.", - "kind": "type_alias", + "kind": "interface", "name": { - "name": "Slices", - "namespace": "_types" + "name": "BengaliAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L361-L366", - "type": { - "items": [ - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "bengali" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "StopWords", + "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SlicesCalculation", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ + }, { - "description": "Let Elasticsearch choose a reasonable number for most data streams and indices.", - "name": "auto" + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } } ], - "name": { - "name": "SlicesCalculation", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L368-L376" - }, - { - "kind": "type_alias", - "name": { - "name": "StreamResult", - "namespace": "_types" - }, - "specLocation": "_types/Binary.ts#L27-L27", - "type": { - "kind": "instance_of", - "type": { - "name": "binary", - "namespace": "_builtins" - } - } + "specLocation": "_types/analysis/analyzers.ts#L93-L98" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "TaskId", - "namespace": "_types" + "name": "BrazilianAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L129-L129", - "type": { - "items": [ - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "brazilian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "StopWords", + "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L100-L104" }, { - "kind": "enum", - "members": [ - { - "name": "cpu" - }, + "kind": "interface", + "name": { + "name": "BulgarianAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "wait" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "bulgarian" + } }, { - "name": "block" + "name": "stopwords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } }, { - "name": "gpu" + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "mem" + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } } ], - "name": { - "name": "ThreadType", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L294-L300" + "specLocation": "_types/analysis/analyzers.ts#L106-L111" }, { - "description": "Time of day, expressed as HH:MM:SS", - "kind": "type_alias", + "kind": "interface", "name": { - "name": "TimeOfDay", - "namespace": "_types" + "name": "CatalanAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/Time.ts#L44-L45", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "kind": "enum", - "members": [ - { - "codegenName": "nanoseconds", - "name": "nanos" - }, - { - "codegenName": "microseconds", - "name": "micros" - }, - { - "codegenName": "milliseconds", - "name": "ms" - }, + "properties": [ { - "codegenName": "seconds", - "name": "s" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "catalan" + } }, { - "codegenName": "minutes", - "name": "m" + "name": "stopwords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } }, { - "codegenName": "hours", - "name": "h" + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "codegenName": "days", - "name": "d" - } - ], - "name": { - "name": "TimeUnit", - "namespace": "_types" - }, - "specLocation": "_types/Time.ts#L69-L77" - }, - { - "kind": "type_alias", - "name": { - "name": "TransportAddress", - "namespace": "_types" - }, - "specLocation": "_types/Networking.ts#L22-L22", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Time unit for fractional milliseconds", - "kind": "type_alias", - "name": { - "name": "UnitFloatMillis", - "namespace": "_types" - }, - "specLocation": "_types/Time.ts#L37-L38", - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "description": "Time unit for milliseconds", - "kind": "type_alias", - "name": { - "name": "UnitMillis", - "namespace": "_types" - }, - "specLocation": "_types/Time.ts#L33-L34", - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Time unit for nanoseconds", - "kind": "type_alias", - "name": { - "name": "UnitNanos", - "namespace": "_types" - }, - "specLocation": "_types/Time.ts#L35-L36", - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Time unit for seconds", - "kind": "type_alias", - "name": { - "name": "UnitSeconds", - "namespace": "_types" - }, - "specLocation": "_types/Time.ts#L29-L30", - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } } - } + ], + "specLocation": "_types/analysis/analyzers.ts#L113-L118" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "Username", - "namespace": "_types" + "name": "ChineseAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L191-L191", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "chinese" + } + }, + { + "name": "stopwords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - } + ], + "specLocation": "_types/analysis/analyzers.ts#L120-L124" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "Uuid", - "namespace": "_types" + "name": "CjkAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L122-L122", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "cjk" + } + }, + { + "name": "stopwords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - } + ], + "specLocation": "_types/analysis/analyzers.ts#L126-L130" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "VersionString", - "namespace": "_types" + "name": "CzechAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L98-L98", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "kind": "enum", - "members": [ + "properties": [ { - "name": "all" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "czech" + } }, { - "name": "index-setting" + "name": "stopwords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } } ], - "name": { - "name": "WaitForActiveShardOptions", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L302-L306" + "specLocation": "_types/analysis/analyzers.ts#L132-L137" }, { - "codegenNames": [ - "count", - "option" - ], - "kind": "type_alias", + "kind": "interface", "name": { - "name": "WaitForActiveShards", - "namespace": "_types" + "name": "DanishAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/common.ts#L139-L140", - "type": { - "items": [ - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "danish" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "StopWords", + "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "WaitForActiveShardOptions", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L139-L143" }, { - "kind": "enum", - "members": [ - { - "name": "immediate" - }, - { - "name": "urgent" - }, + "kind": "interface", + "name": { + "name": "DutchAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "high" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "dutch" + } }, { - "name": "normal" + "name": "stopwords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } }, { - "name": "low" + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "languid" + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } } ], - "name": { - "name": "WaitForEvents", - "namespace": "_types" - }, - "specLocation": "_types/common.ts#L308-L315" + "specLocation": "_types/analysis/analyzers.ts#L145-L150" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "byte", - "namespace": "_types" + "name": "EnglishAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/Numeric.ts#L21-L21", - "type": { - "kind": "instance_of", - "type": { - "name": "number", - "namespace": "_builtins" + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "english" + } + }, + { + "name": "stopwords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } } - } + ], + "specLocation": "_types/analysis/analyzers.ts#L152-L157" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "short", - "namespace": "_types" + "name": "EstonianAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/Numeric.ts#L20-L20", - "type": { - "kind": "instance_of", - "type": { - "name": "number", - "namespace": "_builtins" + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "estonian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } - } + ], + "specLocation": "_types/analysis/analyzers.ts#L159-L163" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "ulong", - "namespace": "_types" + "name": "FinnishAnalyzer", + "namespace": "_types.analysis" }, - "specLocation": "_types/Numeric.ts#L25-L25", - "type": { - "kind": "instance_of", - "type": { - "name": "number", - "namespace": "_builtins" + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "finnish" + } + }, + { + "name": "stopwords", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } } - } + ], + "specLocation": "_types/analysis/analyzers.ts#L165-L170" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "Analyzer", + "name": "FrenchAnalyzer", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/analyzers.ts#L427-L480", - "type": { - "items": [ - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "french" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CustomAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "FingerprintAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L172-L177" + }, + { + "kind": "interface", + "name": { + "name": "GalicianAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "galician" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "KeywordAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "NoriAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "PatternAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L179-L184" + }, + { + "kind": "interface", + "name": { + "name": "GermanAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "german" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SimpleAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "StandardAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "StopAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L186-L191" + }, + { + "kind": "interface", + "name": { + "name": "GreekAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "greek" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "WhitespaceAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IcuAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L193-L197" + }, + { + "kind": "interface", + "name": { + "name": "HindiAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "hindi" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "KuromojiAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SnowballAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "ArabicAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L199-L204" + }, + { + "kind": "interface", + "name": { + "name": "HungarianAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "hungarian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ArmenianAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "BasqueAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "BengaliAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L206-L211" + }, + { + "kind": "interface", + "name": { + "name": "IndonesianAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "indonesian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "BrazilianAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "BulgarianAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "CatalanAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L213-L218" + }, + { + "kind": "interface", + "name": { + "name": "IrishAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "irish" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ChineseAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CjkAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "CzechAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L220-L225" + }, + { + "kind": "interface", + "name": { + "name": "ItalianAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "italian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DanishAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DutchAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "EnglishAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L227-L232" + }, + { + "kind": "interface", + "name": { + "name": "LatvianAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "latvian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "EstonianAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "FinnishAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "FrenchAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L234-L239" + }, + { + "kind": "interface", + "name": { + "name": "LithuanianAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "lithuanian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "GalicianAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "GermanAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "GreekAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L241-L246" + }, + { + "kind": "interface", + "name": { + "name": "NorwegianAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "norwegian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "HindiAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "HungarianAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "IndonesianAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L248-L253" + }, + { + "kind": "interface", + "name": { + "name": "PersianAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "persian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IrishAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ItalianAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L255-L259" + }, + { + "kind": "interface", + "name": { + "name": "PortugueseAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "portuguese" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "LatvianAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "LithuanianAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "NorwegianAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L261-L266" + }, + { + "kind": "interface", + "name": { + "name": "RomanianAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "romanian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "PersianAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "PortugueseAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "RomanianAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L268-L273" + }, + { + "kind": "interface", + "name": { + "name": "RussianAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "russian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "RussianAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SerbianAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "SoraniAnalyzer", - "namespace": "_types.analysis" + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L275-L280" + }, + { + "kind": "interface", + "name": { + "name": "SerbianAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "serbian" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SpanishAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SwedishAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L282-L287" + }, + { + "kind": "interface", + "name": { + "name": "SoraniAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "sorani" + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "TurkishAnalyzer", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ThaiAnalyzer", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - }, - "variants": { - "defaultTag": "custom", - "kind": "internal_tag", - "nonExhaustive": true, - "tag": "type" - } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L289-L294" }, { "kind": "interface", "name": { - "name": "CustomAnalyzer", + "name": "SpanishAnalyzer", "namespace": "_types.analysis" }, "properties": [ @@ -82949,101 +86932,106 @@ "required": true, "type": { "kind": "literal_value", - "value": "custom" + "value": "spanish" } }, { - "name": "char_filter", + "name": "stopwords", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "StopWords", + "namespace": "_types.analysis" + } } }, { - "name": "filter", + "name": "stopwords_path", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "stem_exclusion", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ], - "kind": "union_of" + } + } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L296-L301" + }, + { + "kind": "interface", + "name": { + "name": "SwedishAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "swedish" } }, { - "name": "position_increment_gap", + "name": "stopwords", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "StopWords", + "namespace": "_types.analysis" } } }, { - "name": "position_offset_gap", + "name": "stopwords_path", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "tokenizer", - "required": true, + "name": "stem_exclusion", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } ], - "specLocation": "_types/analysis/analyzers.ts#L28-L35" + "specLocation": "_types/analysis/analyzers.ts#L303-L308" }, { "kind": "interface", "name": { - "name": "FingerprintAnalyzer", + "name": "TurkishAnalyzer", "namespace": "_types.analysis" }, "properties": [ @@ -83052,54 +87040,66 @@ "required": true, "type": { "kind": "literal_value", - "value": "fingerprint" + "value": "turkish" } }, { - "deprecation": { - "description": "", - "version": "7.14.0" - }, - "name": "version", + "name": "stopwords", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "StopWords", + "namespace": "_types.analysis" } } }, { - "description": "The maximum token size to emit. Tokens larger than this size will be discarded.\nDefaults to `255`", - "name": "max_output_size", + "name": "stopwords_path", "required": false, - "serverDefault": 255, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The character to use to concatenate the terms.\nDefaults to a space.", - "name": "separator", + "name": "stem_exclusion", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } + } + ], + "specLocation": "_types/analysis/analyzers.ts#L310-L315" + }, + { + "kind": "interface", + "name": { + "name": "ThaiAnalyzer", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "thai" + } }, { - "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", "name": "stopwords", "required": false, - "serverDefault": "_none_", "type": { "kind": "instance_of", "type": { @@ -83109,7 +87109,6 @@ } }, { - "description": "The path to a file containing stop words.", "name": "stopwords_path", "required": false, "type": { @@ -83121,12 +87120,104 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L37-L64" + "specLocation": "_types/analysis/analyzers.ts#L317-L321" + }, + { + "codegenNames": [ + "name", + "definition" + ], + "extDocId": "analysis-charfilters", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html", + "kind": "type_alias", + "name": { + "name": "CharFilter", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/char_filters.ts#L28-L33", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "CharFilterDefinition", + "namespace": "_types.analysis" + } + } + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "CharFilterDefinition", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/char_filters.ts#L35-L44", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "HtmlStripCharFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MappingCharFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PatternReplaceCharFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationCharFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "KuromojiIterationMarkCharFilter", + "namespace": "_types.analysis" + } + } + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "nonExhaustive": true, + "tag": "type" + } }, { + "inherits": { + "type": { + "name": "CharFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "KeywordAnalyzer", + "name": "HtmlStripCharFilter", "namespace": "_types.analysis" }, "properties": [ @@ -83135,47 +87226,34 @@ "required": true, "type": { "kind": "literal_value", - "value": "keyword" + "value": "html_strip" } }, { - "deprecation": { - "description": "", - "version": "7.14.0" - }, - "name": "version", + "name": "escaped_tags", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } ], - "specLocation": "_types/analysis/analyzers.ts#L66-L70" + "specLocation": "_types/analysis/char_filters.ts#L46-L49" }, { "kind": "interface", "name": { - "name": "NoriAnalyzer", + "name": "CharFilterBase", "namespace": "_types.analysis" }, "properties": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "nori" - } - }, - { - "deprecation": { - "description": "", - "version": "7.14.0" - }, "name": "version", "required": false, "type": { @@ -83185,20 +87263,33 @@ "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/analysis/char_filters.ts#L24-L26" + }, + { + "inherits": { + "type": { + "name": "CharFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "MappingCharFilter", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "decompound_mode", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "NoriDecompoundMode", - "namespace": "_types.analysis" - } + "kind": "literal_value", + "value": "mapping" } }, { - "name": "stoptags", + "name": "mappings", "required": false, "type": { "kind": "array_of", @@ -83212,7 +87303,7 @@ } }, { - "name": "user_dictionary", + "name": "mappings_path", "required": false, "type": { "kind": "instance_of", @@ -83223,31 +87314,18 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L323-L330" + "specLocation": "_types/analysis/char_filters.ts#L51-L55" }, { - "kind": "enum", - "members": [ - { - "name": "discard" - }, - { - "name": "none" - }, - { - "name": "mixed" + "inherits": { + "type": { + "name": "CharFilterBase", + "namespace": "_types.analysis" } - ], - "name": { - "name": "NoriDecompoundMode", - "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/nori-plugin.ts#L22-L26" - }, - { "kind": "interface", "name": { - "name": "PatternAnalyzer", + "name": "PatternReplaceCharFilter", "namespace": "_types.analysis" }, "properties": [ @@ -83256,26 +87334,10 @@ "required": true, "type": { "kind": "literal_value", - "value": "pattern" - } - }, - { - "deprecation": { - "description": "", - "version": "7.14.0" - }, - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" - } + "value": "pattern_replace" } }, { - "description": "Java regular expression flags. Flags should be pipe-separated, eg \"CASE_INSENSITIVE|COMMENTS\".", "name": "flags", "required": false, "type": { @@ -83287,23 +87349,8 @@ } }, { - "description": "Should terms be lowercased or not.\nDefaults to `true`.", - "name": "lowercase", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "A Java regular expression.\nDefaults to `\\W+`.", "name": "pattern", - "required": false, - "serverDefault": "\\W+", + "required": true, "type": { "kind": "instance_of", "type": { @@ -83313,21 +87360,7 @@ } }, { - "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", - "name": "stopwords", - "required": false, - "serverDefault": "_none_", - "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } - } - }, - { - "description": "The path to a file containing stop words.", - "name": "stopwords_path", + "name": "replacement", "required": false, "type": { "kind": "instance_of", @@ -83338,12 +87371,18 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L332-L365" + "specLocation": "_types/analysis/char_filters.ts#L57-L62" }, { + "inherits": { + "type": { + "name": "CharFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "SimpleAnalyzer", + "name": "IcuNormalizationCharFilter", "namespace": "_types.analysis" }, "properties": [ @@ -83352,31 +87391,44 @@ "required": true, "type": { "kind": "literal_value", - "value": "simple" + "value": "icu_normalizer" } }, { - "deprecation": { - "description": "", - "version": "7.14.0" - }, - "name": "version", + "name": "mode", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "IcuNormalizationMode", + "namespace": "_types.analysis" + } + } + }, + { + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuNormalizationType", + "namespace": "_types.analysis" } } } ], - "specLocation": "_types/analysis/analyzers.ts#L367-L371" + "specLocation": "_types/analysis/icu-plugin.ts#L40-L44" }, { + "inherits": { + "type": { + "name": "CharFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "StandardAnalyzer", + "name": "KuromojiIterationMarkCharFilter", "namespace": "_types.analysis" }, "properties": [ @@ -83385,279 +87437,230 @@ "required": true, "type": { "kind": "literal_value", - "value": "standard" - } - }, - { - "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`.", - "name": "max_token_length", - "required": false, - "serverDefault": 255, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "value": "kuromoji_iteration_mark" } }, { - "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", - "name": "stopwords", - "required": false, - "serverDefault": "_none_", + "name": "normalize_kana", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The path to a file containing stop words.", - "name": "stopwords_path", - "required": false, + "name": "normalize_kanji", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } } ], - "specLocation": "_types/analysis/analyzers.ts#L382-L402" + "specLocation": "_types/analysis/kuromoji-plugin.ts#L31-L35" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "int" + }, + { + "name": "float" + }, + { + "name": "identity" + } + ], "name": { - "name": "StopAnalyzer", + "name": "DelimitedPayloadEncoding", "namespace": "_types.analysis" }, - "properties": [ + "specLocation": "_types/analysis/token_filters.ts#L61-L65" + }, + { + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "stop" - } + "name": "front" }, { - "deprecation": { - "description": "", - "version": "7.14.0" - }, - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" - } - } - }, + "name": "back" + } + ], + "name": { + "name": "EdgeNGramSide", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/token_filters.ts#L73-L76" + }, + { + "kind": "enum", + "members": [ { - "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", - "name": "stopwords", - "required": false, - "serverDefault": "_none_", - "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } - } + "name": "shifted" }, { - "description": "The path to a file containing stop words.", - "name": "stopwords_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "non-ignorable" } ], - "specLocation": "_types/analysis/analyzers.ts#L404-L419" + "name": { + "name": "IcuCollationAlternate", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/icu-plugin.ts#L89-L92" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "lower" + }, + { + "name": "upper" + } + ], "name": { - "name": "WhitespaceAnalyzer", + "name": "IcuCollationCaseFirst", "namespace": "_types.analysis" }, - "properties": [ + "specLocation": "_types/analysis/icu-plugin.ts#L94-L97" + }, + { + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "whitespace" - } + "name": "no" }, { - "deprecation": { - "description": "", - "version": "7.14.0" - }, - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" - } - } + "name": "identical" } ], - "specLocation": "_types/analysis/analyzers.ts#L421-L425" - }, - { - "kind": "interface", "name": { - "name": "IcuAnalyzer", + "name": "IcuCollationDecomposition", "namespace": "_types.analysis" }, - "properties": [ + "specLocation": "_types/analysis/icu-plugin.ts#L99-L102" + }, + { + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "icu_analyzer" - } + "name": "primary" }, { - "name": "method", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuNormalizationType", - "namespace": "_types.analysis" - } - } + "name": "secondary" }, { - "name": "mode", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuNormalizationMode", - "namespace": "_types.analysis" - } - } + "name": "tertiary" + }, + { + "name": "quaternary" + }, + { + "name": "identical" } ], - "specLocation": "_types/analysis/icu-plugin.ts#L67-L71" + "name": { + "name": "IcuCollationStrength", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/icu-plugin.ts#L104-L110" }, { "kind": "enum", "members": [ { - "name": "nfc" - }, - { - "name": "nfkc" + "name": "forward" }, { - "name": "nfkc_cf" + "name": "reverse" } ], "name": { - "name": "IcuNormalizationType", + "name": "IcuTransformDirection", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/icu-plugin.ts#L83-L87" + "specLocation": "_types/analysis/icu-plugin.ts#L73-L76" }, { "kind": "enum", "members": [ { - "name": "decompose" + "name": "include" }, { - "name": "compose" + "name": "exclude" } ], "name": { - "name": "IcuNormalizationMode", + "name": "KeepTypesMode", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/icu-plugin.ts#L78-L81" + "specLocation": "_types/analysis/token_filters.ts#L214-L217" }, { - "kind": "interface", + "docId": "analysis-normalizers", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html", + "kind": "type_alias", "name": { - "name": "KuromojiAnalyzer", + "name": "Normalizer", "namespace": "_types.analysis" }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "kuromoji" - } - }, - { - "name": "mode", - "required": true, - "type": { + "specLocation": "_types/analysis/normalizers.ts#L20-L24", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "KuromojiTokenizationMode", + "name": "LowercaseNormalizer", "namespace": "_types.analysis" } - } - }, - { - "name": "user_dictionary", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CustomNormalizer", + "namespace": "_types.analysis" } } - } - ], - "specLocation": "_types/analysis/kuromoji-plugin.ts#L25-L29" + ], + "kind": "union_of" + }, + "variants": { + "defaultTag": "custom", + "kind": "internal_tag", + "tag": "type" + } }, { - "kind": "enum", - "members": [ - { - "name": "normal" - }, - { - "name": "search" - }, - { - "name": "extended" - } - ], + "kind": "interface", "name": { - "name": "KuromojiTokenizationMode", + "name": "LowercaseNormalizer", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/kuromoji-plugin.ts#L52-L56" + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "lowercase" + } + } + ], + "specLocation": "_types/analysis/normalizers.ts#L26-L28" }, { "kind": "interface", "name": { - "name": "SnowballAnalyzer", + "name": "CustomNormalizer", "namespace": "_types.analysis" }, "properties": [ @@ -83666,1125 +87669,601 @@ "required": true, "type": { "kind": "literal_value", - "value": "snowball" + "value": "custom" } }, { - "deprecation": { - "description": "", - "version": "7.14.0" - }, - "name": "version", + "name": "char_filter", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" - } - } - }, - { - "name": "language", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SnowballLanguage", - "namespace": "_types.analysis" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "stopwords", + "name": "filter", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } ], - "specLocation": "_types/analysis/analyzers.ts#L374-L380" + "specLocation": "_types/analysis/normalizers.ts#L30-L34" }, { "kind": "enum", "members": [ { - "name": "Armenian" + "name": "metaphone" }, { - "name": "Basque" + "name": "double_metaphone" }, { - "name": "Catalan" + "name": "soundex" }, { - "name": "Danish" + "name": "refined_soundex" }, { - "name": "Dutch" + "name": "caverphone1" }, { - "name": "English" + "name": "caverphone2" }, { - "name": "Finnish" + "name": "cologne" }, { - "name": "French" + "name": "nysiis" }, { - "name": "German" + "name": "koelnerphonetik" }, { - "name": "German2" + "name": "haasephonetik" }, { - "name": "Hungarian" + "name": "beider_morse" }, { - "name": "Italian" + "name": "daitch_mokotoff" + } + ], + "name": { + "name": "PhoneticEncoder", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/phonetic-plugin.ts#L23-L36" + }, + { + "kind": "enum", + "members": [ + { + "name": "any" }, { - "name": "Kp" + "name": "common" }, { - "name": "Lovins" + "name": "cyrillic" }, { - "name": "Norwegian" + "name": "english" }, { - "name": "Porter" + "name": "french" }, { - "name": "Portuguese" + "name": "german" }, { - "name": "Romanian" + "name": "hebrew" }, { - "name": "Russian" + "name": "hungarian" }, { - "name": "Spanish" + "name": "polish" }, { - "name": "Swedish" + "name": "romanian" }, { - "name": "Turkish" + "name": "russian" + }, + { + "name": "spanish" } ], "name": { - "name": "SnowballLanguage", + "name": "PhoneticLanguage", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/languages.ts#L20-L43" + "specLocation": "_types/analysis/phonetic-plugin.ts#L38-L51" }, { - "kind": "interface", - "name": { - "name": "ArabicAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "arabic" - } + "name": "generic" }, { - "name": "stopwords", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } - } + "name": "ashkenazi" }, { - "name": "stopwords_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "sephardic" + } + ], + "name": { + "name": "PhoneticNameType", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/phonetic-plugin.ts#L53-L57" + }, + { + "kind": "enum", + "members": [ + { + "name": "approx" }, { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } + "name": "exact" } ], - "specLocation": "_types/analysis/analyzers.ts#L72-L77" + "name": { + "name": "PhoneticRuleType", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/phonetic-plugin.ts#L59-L62" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "solr" + }, + { + "name": "wordnet" + } + ], "name": { - "name": "ArmenianAnalyzer", + "name": "SynonymFormat", "namespace": "_types.analysis" }, - "properties": [ + "specLocation": "_types/analysis/token_filters.ts#L104-L107" + }, + { + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "armenian" - } + "name": "letter" }, { - "name": "stopwords", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } - } + "name": "digit" }, { - "name": "stopwords_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "whitespace" }, { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } + "name": "punctuation" + }, + { + "name": "symbol" + }, + { + "name": "custom" } ], - "specLocation": "_types/analysis/analyzers.ts#L79-L84" + "name": { + "name": "TokenChar", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/tokenizers.ts#L59-L66" }, { - "kind": "interface", + "codegenNames": [ + "name", + "definition" + ], + "extDocId": "analysis-tokenfilters", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html", + "kind": "type_alias", "name": { - "name": "BasqueAnalyzer", + "name": "TokenFilter", "namespace": "_types.analysis" }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "basque" - } - }, - { - "name": "stopwords", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + "specLocation": "_types/analysis/token_filters.ts#L345-L350", + "type": { + "items": [ + { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + }, + { + "kind": "instance_of", + "type": { + "name": "TokenFilterDefinition", + "namespace": "_types.analysis" } } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L86-L91" + ], + "kind": "union_of" + } }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "BengaliAnalyzer", + "name": "TokenFilterDefinition", "namespace": "_types.analysis" }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "bengali" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + "specLocation": "_types/analysis/token_filters.ts#L352-L404", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "AsciiFoldingTokenFilter", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "CommonGramsTokenFilter", + "namespace": "_types.analysis" + } + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "ConditionTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "DelimitedPayloadTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L93-L98" - }, - { - "kind": "interface", - "name": { - "name": "BrazilianAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "brazilian" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "EdgeNGramTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ElisionTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L100-L104" - }, - { - "kind": "interface", - "name": { - "name": "BulgarianAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "bulgarian" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "FingerprintTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "HunspellTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + }, + { + "kind": "instance_of", + "type": { + "name": "HyphenationDecompounderTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L106-L111" - }, - { - "kind": "interface", - "name": { - "name": "CatalanAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "catalan" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "KeepTypesTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "KeepWordsTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + }, + { + "kind": "instance_of", + "type": { + "name": "KeywordMarkerTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L113-L118" - }, - { - "kind": "interface", - "name": { - "name": "ChineseAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "chinese" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "KStemTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "LengthTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L120-L124" - }, - { - "kind": "interface", - "name": { - "name": "CjkAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "cjk" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "LimitTokenCountTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "LowercaseTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L126-L130" - }, - { - "kind": "interface", - "name": { - "name": "CzechAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "czech" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "MultiplexerTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "NGramTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + }, + { + "kind": "instance_of", + "type": { + "name": "NoriPartOfSpeechTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L132-L137" - }, - { - "kind": "interface", - "name": { - "name": "DanishAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "danish" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "PatternCaptureTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PatternReplaceTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L139-L143" - }, - { - "kind": "interface", - "name": { - "name": "DutchAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "dutch" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "PorterStemTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PredicateTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + }, + { + "kind": "instance_of", + "type": { + "name": "RemoveDuplicatesTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L145-L150" - }, - { - "kind": "interface", - "name": { - "name": "EnglishAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "english" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "ReverseTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ShingleTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + }, + { + "kind": "instance_of", + "type": { + "name": "SnowballTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L152-L157" - }, - { - "kind": "interface", - "name": { - "name": "EstonianAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "estonian" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { + "kind": "instance_of", + "type": { + "name": "StemmerOverrideTokenFilter", + "namespace": "_types.analysis" + } + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "StemmerTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "StopTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L159-L163" - }, - { - "kind": "interface", - "name": { - "name": "FinnishAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "finnish" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "SynonymGraphTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SynonymTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + }, + { + "kind": "instance_of", + "type": { + "name": "TrimTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L165-L170" - }, - { - "kind": "interface", - "name": { - "name": "FrenchAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "french" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "TruncateTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "UniqueTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + }, + { + "kind": "instance_of", + "type": { + "name": "UppercaseTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L172-L177" - }, - { - "kind": "interface", - "name": { - "name": "GalicianAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "galician" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "WordDelimiterGraphTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "WordDelimiterTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + }, + { + "kind": "instance_of", + "type": { + "name": "KuromojiStemmerTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L179-L184" - }, - { - "kind": "interface", - "name": { - "name": "GermanAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "german" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "KuromojiReadingFormTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "KuromojiPartOfSpeechTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + }, + { + "kind": "instance_of", + "type": { + "name": "IcuCollationTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L186-L191" - }, - { - "kind": "interface", - "name": { - "name": "GreekAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "greek" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "IcuFoldingTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IcuNormalizationTokenFilter", + "namespace": "_types.analysis" } - } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L193-L197" - }, - { - "kind": "interface", - "name": { - "name": "HindiAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "hindi" - } - }, - { - "name": "stopwords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "IcuTransformTokenFilter", "namespace": "_types.analysis" } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PhoneticTokenFilter", + "namespace": "_types.analysis" } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + }, + { + "kind": "instance_of", + "type": { + "name": "DictionaryDecompounderTokenFilter", + "namespace": "_types.analysis" } } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L199-L204" + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "nonExhaustive": true, + "tag": "type" + } }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "HungarianAnalyzer", + "name": "AsciiFoldingTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -84793,106 +88272,63 @@ "required": true, "type": { "kind": "literal_value", - "value": "hungarian" - } - }, - { - "name": "stopwords", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } + "value": "asciifolding" } }, { - "name": "stopwords_path", + "name": "preserve_original", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "Stringified", + "namespace": "_spec_utils" } } } ], - "specLocation": "_types/analysis/analyzers.ts#L206-L211" + "specLocation": "_types/analysis/token_filters.ts#L169-L172" }, { "kind": "interface", "name": { - "name": "IndonesianAnalyzer", + "name": "TokenFilterBase", "namespace": "_types.analysis" }, "properties": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "indonesian" - } - }, - { - "name": "stopwords", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } - } - }, - { - "name": "stopwords_path", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "VersionString", + "namespace": "_types" } } } ], - "specLocation": "_types/analysis/analyzers.ts#L213-L218" + "specLocation": "_types/analysis/token_filters.ts#L39-L41" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "IrishAnalyzer", + "name": "CommonGramsTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -84901,33 +88337,11 @@ "required": true, "type": { "kind": "literal_value", - "value": "irish" - } - }, - { - "name": "stopwords", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } - } - }, - { - "name": "stopwords_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "value": "common_grams" } }, { - "name": "stem_exclusion", + "name": "common_words", "required": false, "type": { "kind": "array_of", @@ -84939,50 +88353,67 @@ } } } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L220-L225" - }, - { - "kind": "interface", - "name": { - "name": "ItalianAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "common_words_path", + "required": false, "type": { - "kind": "literal_value", - "value": "italian" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "stopwords", + "name": "ignore_case", "required": false, "type": { "kind": "instance_of", "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "stopwords_path", + "name": "query_mode", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L174-L180" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "ConditionTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "condition" + } }, { - "name": "stem_exclusion", - "required": false, + "name": "filter", + "required": true, "type": { "kind": "array_of", "value": { @@ -84993,14 +88424,31 @@ } } } + }, + { + "name": "script", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } } ], - "specLocation": "_types/analysis/analyzers.ts#L227-L232" + "specLocation": "_types/analysis/token_filters.ts#L182-L186" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "LatvianAnalyzer", + "name": "DelimitedPayloadTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85009,22 +88457,11 @@ "required": true, "type": { "kind": "literal_value", - "value": "latvian" - } - }, - { - "name": "stopwords", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } + "value": "delimited_payload" } }, { - "name": "stopwords_path", + "name": "delimiter", "required": false, "type": { "kind": "instance_of", @@ -85035,26 +88472,29 @@ } }, { - "name": "stem_exclusion", + "name": "encoding", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "DelimitedPayloadEncoding", + "namespace": "_types.analysis" } } } ], - "specLocation": "_types/analysis/analyzers.ts#L234-L239" + "specLocation": "_types/analysis/token_filters.ts#L67-L71" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "LithuanianAnalyzer", + "name": "EdgeNGramTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85063,52 +88503,75 @@ "required": true, "type": { "kind": "literal_value", - "value": "lithuanian" + "value": "edge_ngram" } }, { - "name": "stopwords", + "name": "max_gram", "required": false, "type": { "kind": "instance_of", "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "name": "integer", + "namespace": "_types" } } }, { - "name": "stopwords_path", + "name": "min_gram", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "stem_exclusion", + "name": "side", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "EdgeNGramSide", + "namespace": "_types.analysis" + } + } + }, + { + "name": "preserve_original", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } + ], + "kind": "instance_of", + "type": { + "name": "Stringified", + "namespace": "_spec_utils" } } } ], - "specLocation": "_types/analysis/analyzers.ts#L241-L246" + "specLocation": "_types/analysis/token_filters.ts#L78-L84" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "NorwegianAnalyzer", + "name": "ElisionTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85117,22 +88580,25 @@ "required": true, "type": { "kind": "literal_value", - "value": "norwegian" + "value": "elision" } }, { - "name": "stopwords", + "name": "articles", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "stopwords_path", + "name": "articles_path", "required": false, "type": { "kind": "instance_of", @@ -85143,26 +88609,38 @@ } }, { - "name": "stem_exclusion", + "name": "articles_case", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } + ], + "kind": "instance_of", + "type": { + "name": "Stringified", + "namespace": "_spec_utils" } } } ], - "specLocation": "_types/analysis/analyzers.ts#L248-L253" + "specLocation": "_types/analysis/token_filters.ts#L188-L193" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "PersianAnalyzer", + "name": "FingerprintTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85171,22 +88649,22 @@ "required": true, "type": { "kind": "literal_value", - "value": "persian" + "value": "fingerprint" } }, { - "name": "stopwords", + "name": "max_output_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "name": "integer", + "namespace": "_types" } } }, { - "name": "stopwords_path", + "name": "separator", "required": false, "type": { "kind": "instance_of", @@ -85197,12 +88675,18 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L255-L259" + "specLocation": "_types/analysis/token_filters.ts#L195-L199" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "PortugueseAnalyzer", + "name": "HunspellTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85211,22 +88695,22 @@ "required": true, "type": { "kind": "literal_value", - "value": "portuguese" + "value": "hunspell" } }, { - "name": "stopwords", + "name": "dedup", "required": false, "type": { "kind": "instance_of", "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "stopwords_path", + "name": "dictionary", "required": false, "type": { "kind": "instance_of", @@ -85237,26 +88721,40 @@ } }, { - "name": "stem_exclusion", + "name": "locale", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "longest_only", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "_types/analysis/analyzers.ts#L261-L266" + "specLocation": "_types/analysis/token_filters.ts#L201-L207" }, { + "inherits": { + "type": { + "name": "CompoundWordTokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "RomanianAnalyzer", + "name": "HyphenationDecompounderTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85265,87 +88763,82 @@ "required": true, "type": { "kind": "literal_value", - "value": "romanian" + "value": "hyphenation_decompounder" } - }, + } + ], + "specLocation": "_types/analysis/token_filters.ts#L57-L59" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "CompoundWordTokenFilterBase", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "stopwords", + "name": "hyphenation_patterns_path", "required": false, "type": { "kind": "instance_of", "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "stopwords_path", + "name": "max_subword_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "stem_exclusion", + "name": "min_subword_size", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "_types/analysis/analyzers.ts#L268-L273" - }, - { - "kind": "interface", - "name": { - "name": "RussianAnalyzer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "russian" - } }, { - "name": "stopwords", + "name": "min_word_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "name": "integer", + "namespace": "_types" } } }, { - "name": "stopwords_path", + "name": "only_longest_match", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "stem_exclusion", + "name": "word_list", "required": false, "type": { "kind": "array_of", @@ -85357,14 +88850,31 @@ } } } + }, + { + "name": "word_list_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "_types/analysis/analyzers.ts#L275-L280" + "specLocation": "_types/analysis/token_filters.ts#L43-L51" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "SerbianAnalyzer", + "name": "KeepTypesTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85373,33 +88883,22 @@ "required": true, "type": { "kind": "literal_value", - "value": "serbian" + "value": "keep_types" } }, { - "name": "stopwords", + "name": "mode", "required": false, "type": { "kind": "instance_of", "type": { - "name": "StopWords", + "name": "KeepTypesMode", "namespace": "_types.analysis" } } }, { - "name": "stopwords_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "stem_exclusion", + "name": "types", "required": false, "type": { "kind": "array_of", @@ -85413,12 +88912,18 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L282-L287" + "specLocation": "_types/analysis/token_filters.ts#L219-L223" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "SoraniAnalyzer", + "name": "KeepWordsTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85427,52 +88932,58 @@ "required": true, "type": { "kind": "literal_value", - "value": "sorani" + "value": "keep" } }, { - "name": "stopwords", + "name": "keep_words", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "stopwords_path", + "name": "keep_words_case", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "stem_exclusion", + "name": "keep_words_path", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/analysis/analyzers.ts#L289-L294" + "specLocation": "_types/analysis/token_filters.ts#L225-L230" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "SpanishAnalyzer", + "name": "KeywordMarkerTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85481,22 +88992,48 @@ "required": true, "type": { "kind": "literal_value", - "value": "spanish" + "value": "keyword_marker" } }, { - "name": "stopwords", + "name": "ignore_case", "required": false, "type": { "kind": "instance_of", "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "stopwords_path", + "name": "keywords", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" + } + }, + { + "name": "keywords_path", "required": false, "type": { "kind": "instance_of", @@ -85507,26 +89044,53 @@ } }, { - "name": "stem_exclusion", + "name": "keywords_pattern", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/analysis/analyzers.ts#L296-L301" + "specLocation": "_types/analysis/token_filters.ts#L232-L238" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "KStemTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "kstem" + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L240-L242" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "SwedishAnalyzer", + "name": "LengthTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85535,52 +89099,44 @@ "required": true, "type": { "kind": "literal_value", - "value": "swedish" + "value": "length" } }, { - "name": "stopwords", + "name": "max", "required": false, "type": { "kind": "instance_of", "type": { - "name": "StopWords", - "namespace": "_types.analysis" + "name": "integer", + "namespace": "_types" } } }, { - "name": "stopwords_path", + "name": "min", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "stem_exclusion", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "_types/analysis/analyzers.ts#L303-L308" + "specLocation": "_types/analysis/token_filters.ts#L244-L248" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "TurkishAnalyzer", + "name": "LimitTokenCountTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85589,52 +89145,53 @@ "required": true, "type": { "kind": "literal_value", - "value": "turkish" - } - }, - { - "name": "stopwords", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } + "value": "limit" } }, { - "name": "stopwords_path", + "name": "consume_all_tokens", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "stem_exclusion", + "name": "max_token_count", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } + ], + "kind": "instance_of", + "type": { + "name": "Stringified", + "namespace": "_spec_utils" } } } ], - "specLocation": "_types/analysis/analyzers.ts#L310-L315" + "specLocation": "_types/analysis/token_filters.ts#L250-L254" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "ThaiAnalyzer", + "name": "LowercaseTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85643,22 +89200,11 @@ "required": true, "type": { "kind": "literal_value", - "value": "thai" - } - }, - { - "name": "stopwords", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } + "value": "lowercase" } }, { - "name": "stopwords_path", + "name": "language", "required": false, "type": { "kind": "instance_of", @@ -85669,104 +89215,18 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L317-L321" - }, - { - "codegenNames": [ - "name", - "definition" - ], - "extDocId": "analysis-charfilters", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html", - "kind": "type_alias", - "name": { - "name": "CharFilter", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/char_filters.ts#L28-L33", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "CharFilterDefinition", - "namespace": "_types.analysis" - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "CharFilterDefinition", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/char_filters.ts#L35-L44", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "HtmlStripCharFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "MappingCharFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "PatternReplaceCharFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "IcuNormalizationCharFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "KuromojiIterationMarkCharFilter", - "namespace": "_types.analysis" - } - } - ], - "kind": "union_of" - }, - "variants": { - "kind": "internal_tag", - "nonExhaustive": true, - "tag": "type" - } + "specLocation": "_types/analysis/token_filters.ts#L256-L259" }, { "inherits": { "type": { - "name": "CharFilterBase", + "name": "TokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "HtmlStripCharFilter", + "name": "MultiplexerTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85775,12 +89235,12 @@ "required": true, "type": { "kind": "literal_value", - "value": "html_strip" + "value": "multiplexer" } }, { - "name": "escaped_tags", - "required": false, + "name": "filters", + "required": true, "type": { "kind": "array_of", "value": { @@ -85791,41 +89251,40 @@ } } } - } - ], - "specLocation": "_types/analysis/char_filters.ts#L46-L49" - }, - { - "kind": "interface", - "name": { - "name": "CharFilterBase", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "version", + "name": "preserve_original", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "Stringified", + "namespace": "_spec_utils" } } } ], - "specLocation": "_types/analysis/char_filters.ts#L24-L26" + "specLocation": "_types/analysis/token_filters.ts#L261-L265" }, { "inherits": { "type": { - "name": "CharFilterBase", + "name": "TokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "MappingCharFilter", + "name": "NGramTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85834,47 +89293,64 @@ "required": true, "type": { "kind": "literal_value", - "value": "mapping" + "value": "ngram" } }, { - "name": "mappings", + "name": "max_gram", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "name": "mappings_path", + "name": "min_gram", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "preserve_original", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], + "kind": "instance_of", + "type": { + "name": "Stringified", + "namespace": "_spec_utils" } } } ], - "specLocation": "_types/analysis/char_filters.ts#L51-L55" + "specLocation": "_types/analysis/token_filters.ts#L267-L272" }, { "inherits": { "type": { - "name": "CharFilterBase", + "name": "TokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "PatternReplaceCharFilter", + "name": "NoriPartOfSpeechTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85883,55 +89359,36 @@ "required": true, "type": { "kind": "literal_value", - "value": "pattern_replace" - } - }, - { - "name": "flags", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "pattern", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "value": "nori_part_of_speech" } }, { - "name": "replacement", + "name": "stoptags", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } ], - "specLocation": "_types/analysis/char_filters.ts#L57-L62" + "specLocation": "_types/analysis/token_filters.ts#L274-L277" }, { "inherits": { "type": { - "name": "CharFilterBase", + "name": "TokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "IcuNormalizationCharFilter", + "name": "PatternCaptureTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85940,44 +89397,56 @@ "required": true, "type": { "kind": "literal_value", - "value": "icu_normalizer" + "value": "pattern_capture" } }, { - "name": "mode", - "required": false, + "name": "patterns", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "IcuNormalizationMode", - "namespace": "_types.analysis" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "name", + "name": "preserve_original", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "IcuNormalizationType", - "namespace": "_types.analysis" + "name": "Stringified", + "namespace": "_spec_utils" } } } ], - "specLocation": "_types/analysis/icu-plugin.ts#L40-L44" + "specLocation": "_types/analysis/token_filters.ts#L279-L283" }, { "inherits": { "type": { - "name": "CharFilterBase", + "name": "TokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "KuromojiIterationMarkCharFilter", + "name": "PatternReplaceTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -85986,12 +89455,12 @@ "required": true, "type": { "kind": "literal_value", - "value": "kuromoji_iteration_mark" + "value": "pattern_replace" } }, { - "name": "normalize_kana", - "required": true, + "name": "all", + "required": false, "type": { "kind": "instance_of", "type": { @@ -86001,197 +89470,134 @@ } }, { - "name": "normalize_kanji", - "required": true, + "name": "flags", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - } - ], - "specLocation": "_types/analysis/kuromoji-plugin.ts#L31-L35" - }, - { - "kind": "enum", - "members": [ - { - "name": "int" - }, - { - "name": "float" - }, - { - "name": "identity" - } - ], - "name": { - "name": "DelimitedPayloadEncoding", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/token_filters.ts#L61-L65" - }, - { - "kind": "enum", - "members": [ - { - "name": "front" }, { - "name": "back" - } - ], - "name": { - "name": "EdgeNGramSide", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/token_filters.ts#L73-L76" - }, - { - "kind": "enum", - "members": [ - { - "name": "shifted" + "name": "pattern", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "non-ignorable" + "name": "replacement", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "IcuCollationAlternate", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/icu-plugin.ts#L89-L92" + "specLocation": "_types/analysis/token_filters.ts#L285-L291" }, { - "kind": "enum", - "members": [ - { - "name": "lower" - }, - { - "name": "upper" + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" } - ], - "name": { - "name": "IcuCollationCaseFirst", - "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/icu-plugin.ts#L94-L97" - }, - { - "kind": "enum", - "members": [ - { - "name": "no" - }, - { - "name": "identical" - } - ], + "kind": "interface", "name": { - "name": "IcuCollationDecomposition", + "name": "PorterStemTokenFilter", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/icu-plugin.ts#L99-L102" - }, - { - "kind": "enum", - "members": [ - { - "name": "primary" - }, - { - "name": "secondary" - }, - { - "name": "tertiary" - }, - { - "name": "quaternary" - }, + "properties": [ { - "name": "identical" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "porter_stem" + } } ], - "name": { - "name": "IcuCollationStrength", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/icu-plugin.ts#L104-L110" + "specLocation": "_types/analysis/token_filters.ts#L293-L295" }, - { - "kind": "enum", - "members": [ - { - "name": "forward" - }, - { - "name": "reverse" + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" } - ], + }, + "kind": "interface", "name": { - "name": "IcuTransformDirection", + "name": "PredicateTokenFilter", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/icu-plugin.ts#L73-L76" - }, - { - "kind": "enum", - "members": [ + "properties": [ { - "name": "include" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "predicate_token_filter" + } }, { - "name": "exclude" + "name": "script", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } } ], - "name": { - "name": "KeepTypesMode", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/token_filters.ts#L214-L217" + "specLocation": "_types/analysis/token_filters.ts#L297-L300" }, { - "docId": "analysis-normalizers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html", - "kind": "type_alias", + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", "name": { - "name": "Normalizer", + "name": "RemoveDuplicatesTokenFilter", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/normalizers.ts#L20-L24", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "LowercaseNormalizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "CustomNormalizer", - "namespace": "_types.analysis" - } + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "remove_duplicates" } - ], - "kind": "union_of" - }, - "variants": { - "defaultTag": "custom", - "kind": "internal_tag", - "tag": "type" - } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L302-L304" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "LowercaseNormalizer", + "name": "ReverseTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -86200,16 +89606,22 @@ "required": true, "type": { "kind": "literal_value", - "value": "lowercase" + "value": "reverse" } } ], - "specLocation": "_types/analysis/normalizers.ts#L26-L28" + "specLocation": "_types/analysis/token_filters.ts#L306-L308" }, { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, "kind": "interface", "name": { - "name": "CustomNormalizer", + "name": "ShingleTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -86218,590 +89630,843 @@ "required": true, "type": { "kind": "literal_value", - "value": "custom" + "value": "shingle" } }, { - "name": "char_filter", + "name": "filler_token", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "filter", + "name": "max_shingle_size", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } + ], + "kind": "union_of" } - } - ], - "specLocation": "_types/analysis/normalizers.ts#L30-L34" - }, - { - "kind": "enum", - "members": [ - { - "name": "metaphone" - }, - { - "name": "double_metaphone" - }, - { - "name": "soundex" }, { - "name": "refined_soundex" - }, - { - "name": "caverphone1" - }, - { - "name": "caverphone2" - }, - { - "name": "cologne" - }, - { - "name": "nysiis" - }, - { - "name": "koelnerphonetik" + "name": "min_shingle_size", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } }, { - "name": "haasephonetik" + "name": "output_unigrams", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "name": "beider_morse" + "name": "output_unigrams_if_no_shingles", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "name": "daitch_mokotoff" + "name": "token_separator", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "PhoneticEncoder", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/phonetic-plugin.ts#L23-L36" + "specLocation": "_types/analysis/token_filters.ts#L86-L94" }, { - "kind": "enum", - "members": [ - { - "name": "any" - }, - { - "name": "common" - }, - { - "name": "cyrillic" - }, - { - "name": "english" - }, - { - "name": "french" - }, - { - "name": "german" - }, - { - "name": "hebrew" - }, - { - "name": "hungarian" - }, - { - "name": "polish" - }, - { - "name": "romanian" - }, - { - "name": "russian" - }, - { - "name": "spanish" + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" } - ], - "name": { - "name": "PhoneticLanguage", - "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/phonetic-plugin.ts#L38-L51" - }, - { - "kind": "enum", - "members": [ - { - "name": "generic" - }, - { - "name": "ashkenazi" - }, - { - "name": "sephardic" - } - ], + "kind": "interface", "name": { - "name": "PhoneticNameType", + "name": "SnowballTokenFilter", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/phonetic-plugin.ts#L53-L57" - }, - { - "kind": "enum", - "members": [ + "properties": [ { - "name": "approx" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "snowball" + } }, { - "name": "exact" + "name": "language", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SnowballLanguage", + "namespace": "_types.analysis" + } + } } ], - "name": { - "name": "PhoneticRuleType", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/phonetic-plugin.ts#L59-L62" + "specLocation": "_types/analysis/token_filters.ts#L310-L313" }, { - "kind": "enum", - "members": [ - { - "name": "solr" - }, - { - "name": "wordnet" + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" } - ], + }, + "kind": "interface", "name": { - "name": "SynonymFormat", + "name": "StemmerOverrideTokenFilter", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/token_filters.ts#L104-L107" - }, - { - "kind": "enum", - "members": [ - { - "name": "letter" - }, - { - "name": "digit" - }, - { - "name": "whitespace" - }, + "properties": [ { - "name": "punctuation" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "stemmer_override" + } }, { - "name": "symbol" + "name": "rules", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } }, { - "name": "custom" - } - ], - "name": { - "name": "TokenChar", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/tokenizers.ts#L59-L66" - }, - { - "codegenNames": [ - "name", - "definition" - ], - "extDocId": "analysis-tokenfilters", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html", - "kind": "type_alias", - "name": { - "name": "TokenFilter", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/token_filters.ts#L345-L350", - "type": { - "items": [ - { + "name": "rules_path", + "required": false, + "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "TokenFilterDefinition", - "namespace": "_types.analysis" - } } - ], - "kind": "union_of" - } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L315-L319" }, { - "kind": "type_alias", + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", "name": { - "name": "TokenFilterDefinition", + "name": "StemmerTokenFilter", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/token_filters.ts#L352-L404", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "AsciiFoldingTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "CommonGramsTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ConditionTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DelimitedPayloadTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "EdgeNGramTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ElisionTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "FingerprintTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "HunspellTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "HyphenationDecompounderTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "KeepTypesTokenFilter", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "KeepWordsTokenFilter", - "namespace": "_types.analysis" - } - }, - { + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "stemmer" + } + }, + { + "aliases": [ + "name" + ], + "name": "language", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "KeywordMarkerTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L321-L325" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "StopTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "stop" + } + }, + { + "name": "ignore_case", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "KStemTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "remove_trailing", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "LengthTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "stopwords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "LimitTokenCountTokenFilter", + "name": "StopWords", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "stopwords_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "LowercaseTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L96-L102" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "SynonymGraphTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "synonym_graph" + } + }, + { + "name": "expand", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "MultiplexerTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "format", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "NGramTokenFilter", + "name": "SynonymFormat", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "lenient", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "NoriPartOfSpeechTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "PatternCaptureTokenFilter", - "namespace": "_types.analysis" + } + }, + { + "name": "synonyms", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + }, + { + "name": "synonyms_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "PatternReplaceTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "synonyms_set", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "PorterStemTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "tokenizer", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "PredicateTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "updateable", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "RemoveDuplicatesTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L109-L119" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "SynonymTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "synonym" + } + }, + { + "name": "expand", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ReverseTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "format", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ShingleTokenFilter", + "name": "SynonymFormat", "namespace": "_types.analysis" } - }, - { + } + }, + { + "name": "lenient", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SnowballTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "StemmerOverrideTokenFilter", - "namespace": "_types.analysis" + } + }, + { + "name": "synonyms", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, - { + } + }, + { + "name": "synonyms_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "StemmerTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "synonyms_set", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "StopTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "tokenizer", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SynonymGraphTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "updateable", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SynonymTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L121-L131" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "TrimTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "trim" + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L327-L329" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "TruncateTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "truncate" + } + }, + { + "name": "length", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "TrimTokenFilter", - "namespace": "_types.analysis" + "name": "integer", + "namespace": "_types" } - }, - { + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L331-L334" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "UniqueTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "unique" + } + }, + { + "name": "only_on_same_position", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "TruncateTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L336-L339" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "UppercaseTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "uppercase" + } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L341-L343" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "WordDelimiterGraphTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "word_delimiter_graph" + } + }, + { + "name": "adjust_offsets", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "UniqueTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "catenate_all", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "UppercaseTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "catenate_numbers", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "WordDelimiterGraphTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "catenate_words", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "WordDelimiterTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "generate_number_parts", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "KuromojiStemmerTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "generate_word_parts", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "KuromojiReadingFormTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "ignore_keywords", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "KuromojiPartOfSpeechTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "preserve_original", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "IcuCollationTokenFilter", - "namespace": "_types.analysis" + "name": "Stringified", + "namespace": "_spec_utils" } - }, - { + } + }, + { + "name": "protected_words", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "protected_words_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IcuFoldingTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "split_on_case_change", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IcuNormalizationTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "split_on_numerics", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IcuTransformTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "stem_english_possessive", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "PhoneticTokenFilter", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "type_table", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "type_table_path", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DictionaryDecompounderTokenFilter", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - }, - "variants": { - "kind": "internal_tag", - "nonExhaustive": true, - "tag": "type" - } + } + ], + "specLocation": "_types/analysis/token_filters.ts#L150-L167" }, { "inherits": { @@ -86812,7 +90477,7 @@ }, "kind": "interface", "name": { - "name": "AsciiFoldingTokenFilter", + "name": "WordDelimiterTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -86821,7 +90486,62 @@ "required": true, "type": { "kind": "literal_value", - "value": "asciifolding" + "value": "word_delimiter" + } + }, + { + "name": "catenate_all", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "catenate_numbers", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "catenate_words", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "generate_number_parts", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "generate_word_parts", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } }, { @@ -86843,54 +90563,9 @@ "namespace": "_spec_utils" } } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L169-L172" - }, - { - "kind": "interface", - "name": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "version", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionString", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L39-L41" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "CommonGramsTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "common_grams" - } }, { - "name": "common_words", + "name": "protected_words", "required": false, "type": { "kind": "array_of", @@ -86904,7 +90579,7 @@ } }, { - "name": "common_words_path", + "name": "protected_words_path", "required": false, "type": { "kind": "instance_of", @@ -86915,7 +90590,7 @@ } }, { - "name": "ignore_case", + "name": "split_on_case_change", "required": false, "type": { "kind": "instance_of", @@ -86926,7 +90601,18 @@ } }, { - "name": "query_mode", + "name": "split_on_numerics", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "stem_english_possessive", "required": false, "type": { "kind": "instance_of", @@ -86935,9 +90621,34 @@ "namespace": "_builtins" } } + }, + { + "name": "type_table", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "type_table_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "_types/analysis/token_filters.ts#L174-L180" + "specLocation": "_types/analysis/token_filters.ts#L133-L148" }, { "inherits": { @@ -86948,7 +90659,7 @@ }, "kind": "interface", "name": { - "name": "ConditionTokenFilter", + "name": "KuromojiStemmerTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -86957,36 +90668,22 @@ "required": true, "type": { "kind": "literal_value", - "value": "condition" - } - }, - { - "name": "filter", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "value": "kuromoji_stemmer" } }, { - "name": "script", + "name": "minimum_length", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "_types/analysis/token_filters.ts#L182-L186" + "specLocation": "_types/analysis/kuromoji-plugin.ts#L47-L50" }, { "inherits": { @@ -86997,7 +90694,7 @@ }, "kind": "interface", "name": { - "name": "DelimitedPayloadTokenFilter", + "name": "KuromojiReadingFormTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -87006,33 +90703,60 @@ "required": true, "type": { "kind": "literal_value", - "value": "delimited_payload" + "value": "kuromoji_readingform" } }, { - "name": "delimiter", - "required": false, + "name": "use_romaji", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } + } + ], + "specLocation": "_types/analysis/kuromoji-plugin.ts#L42-L45" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "KuromojiPartOfSpeechTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "kuromoji_part_of_speech" + } }, { - "name": "encoding", - "required": false, + "name": "stoptags", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "DelimitedPayloadEncoding", - "namespace": "_types.analysis" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } ], - "specLocation": "_types/analysis/token_filters.ts#L67-L71" + "specLocation": "_types/analysis/kuromoji-plugin.ts#L37-L40" }, { "inherits": { @@ -87043,7 +90767,7 @@ }, "kind": "interface", "name": { - "name": "EdgeNGramTokenFilter", + "name": "IcuCollationTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -87052,102 +90776,121 @@ "required": true, "type": { "kind": "literal_value", - "value": "edge_ngram" + "value": "icu_collation" } }, { - "name": "max_gram", + "name": "alternate", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IcuCollationAlternate", + "namespace": "_types.analysis" } } }, { - "name": "min_gram", + "name": "case_first", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IcuCollationCaseFirst", + "namespace": "_types.analysis" } } }, { - "name": "side", + "name": "case_level", "required": false, "type": { "kind": "instance_of", "type": { - "name": "EdgeNGramSide", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "country", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "decomposition", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuCollationDecomposition", "namespace": "_types.analysis" } } }, { - "name": "preserve_original", + "name": "hiragana_quaternary_mode", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L78-L84" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "ElisionTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "language", + "required": false, "type": { - "kind": "literal_value", - "value": "elision" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "articles", + "name": "numeric", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "rules", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "strength", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IcuCollationStrength", + "namespace": "_types.analysis" } } }, { - "name": "articles_path", + "name": "variable_top", "required": false, "type": { "kind": "instance_of", @@ -87158,27 +90901,18 @@ } }, { - "name": "articles_case", + "name": "variant", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/analysis/token_filters.ts#L188-L193" + "specLocation": "_types/analysis/icu-plugin.ts#L51-L65" }, { "inherits": { @@ -87189,7 +90923,7 @@ }, "kind": "interface", "name": { - "name": "FingerprintTokenFilter", + "name": "IcuFoldingTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -87198,23 +90932,12 @@ "required": true, "type": { "kind": "literal_value", - "value": "fingerprint" - } - }, - { - "name": "max_output_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "value": "icu_folding" } }, { - "name": "separator", - "required": false, + "name": "unicode_set_filter", + "required": true, "type": { "kind": "instance_of", "type": { @@ -87224,7 +90947,7 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L195-L199" + "specLocation": "_types/analysis/icu-plugin.ts#L46-L49" }, { "inherits": { @@ -87235,7 +90958,7 @@ }, "kind": "interface", "name": { - "name": "HunspellTokenFilter", + "name": "IcuNormalizationTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -87244,66 +90967,79 @@ "required": true, "type": { "kind": "literal_value", - "value": "hunspell" + "value": "icu_normalizer" } }, { - "name": "dedup", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IcuNormalizationType", + "namespace": "_types.analysis" } } - }, + } + ], + "specLocation": "_types/analysis/icu-plugin.ts#L35-L38" + }, + { + "inherits": { + "type": { + "name": "TokenFilterBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "IcuTransformTokenFilter", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "dictionary", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "icu_transform" } }, { - "name": "locale", - "required": true, + "name": "dir", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IcuTransformDirection", + "namespace": "_types.analysis" } } }, { - "name": "longest_only", - "required": false, + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "_types/analysis/token_filters.ts#L201-L207" + "specLocation": "_types/analysis/icu-plugin.ts#L24-L28" }, { "inherits": { "type": { - "name": "CompoundWordTokenFilterBase", + "name": "TokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "HyphenationDecompounderTokenFilter", + "name": "PhoneticTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -87312,49 +91048,48 @@ "required": true, "type": { "kind": "literal_value", - "value": "hyphenation_decompounder" + "value": "phonetic" } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L57-L59" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "CompoundWordTokenFilterBase", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "hyphenation_patterns_path", - "required": false, + "name": "encoder", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PhoneticEncoder", + "namespace": "_types.analysis" } } }, { - "name": "max_subword_size", + "name": "languageset", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "PhoneticLanguage", + "namespace": "_types.analysis" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PhoneticLanguage", + "namespace": "_types.analysis" + } + } + } + ], + "kind": "union_of" } }, { - "name": "min_subword_size", + "name": "max_code_len", "required": false, "type": { "kind": "instance_of", @@ -87365,18 +91100,18 @@ } }, { - "name": "min_word_size", + "name": "name_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "PhoneticNameType", + "namespace": "_types.analysis" } } }, { - "name": "only_longest_match", + "name": "replace", "required": false, "type": { "kind": "instance_of", @@ -87387,43 +91122,29 @@ } }, { - "name": "word_list", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "word_list_path", + "name": "rule_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PhoneticRuleType", + "namespace": "_types.analysis" } } } ], - "specLocation": "_types/analysis/token_filters.ts#L43-L51" + "specLocation": "_types/analysis/phonetic-plugin.ts#L64-L72" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "CompoundWordTokenFilterBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "KeepTypesTokenFilter", + "name": "DictionaryDecompounderTokenFilter", "namespace": "_types.analysis" }, "properties": [ @@ -87432,47 +91153,199 @@ "required": true, "type": { "kind": "literal_value", - "value": "keep_types" + "value": "dictionary_decompounder" } - }, - { - "name": "mode", - "required": false, - "type": { + } + ], + "specLocation": "_types/analysis/token_filters.ts#L53-L55" + }, + { + "codegenNames": [ + "name", + "definition" + ], + "extDocId": "analysis-tokenizers", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", + "kind": "type_alias", + "name": { + "name": "Tokenizer", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/tokenizers.ts#L140-L145", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "KeepTypesMode", + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TokenizerDefinition", "namespace": "_types.analysis" } } - }, - { - "name": "types", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "TokenizerDefinition", + "namespace": "_types.analysis" + }, + "specLocation": "_types/analysis/tokenizers.ts#L147-L170", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "CharGroupTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ClassicTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "EdgeNGramTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "KeywordTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "LetterTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "LowercaseTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NGramTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PathHierarchyTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PatternTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SimplePatternTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SimplePatternSplitTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StandardTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ThaiTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "UaxEmailUrlTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "WhitespaceTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IcuTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "KuromojiTokenizer", + "namespace": "_types.analysis" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NoriTokenizer", + "namespace": "_types.analysis" } } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L219-L223" + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "nonExhaustive": true, + "tag": "type" + } }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "KeepWordsTokenFilter", + "name": "CharGroupTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -87481,12 +91354,12 @@ "required": true, "type": { "kind": "literal_value", - "value": "keep" + "value": "char_group" } }, { - "name": "keep_words", - "required": false, + "name": "tokenize_on_chars", + "required": true, "type": { "kind": "array_of", "value": { @@ -87499,123 +91372,50 @@ } }, { - "name": "keep_words_case", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "keep_words_path", + "name": "max_token_length", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "_types/analysis/token_filters.ts#L225-L230" + "specLocation": "_types/analysis/tokenizers.ts#L31-L38" }, { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, "kind": "interface", "name": { - "name": "KeywordMarkerTokenFilter", + "name": "TokenizerBase", "namespace": "_types.analysis" }, "properties": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "keyword_marker" - } - }, - { - "name": "ignore_case", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "keywords", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" - } - }, - { - "name": "keywords_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "keywords_pattern", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } } ], - "specLocation": "_types/analysis/token_filters.ts#L232-L238" + "specLocation": "_types/analysis/tokenizers.ts#L27-L29" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "KStemTokenFilter", + "name": "ClassicTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -87624,22 +91424,33 @@ "required": true, "type": { "kind": "literal_value", - "value": "kstem" + "value": "classic" + } + }, + { + "name": "max_token_length", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } ], - "specLocation": "_types/analysis/token_filters.ts#L240-L242" + "specLocation": "_types/analysis/tokenizers.ts#L40-L46" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "LengthTokenFilter", + "name": "EdgeNGramTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -87648,11 +91459,22 @@ "required": true, "type": { "kind": "literal_value", - "value": "length" + "value": "edge_ngram" } }, { - "name": "max", + "name": "custom_token_chars", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "max_gram", "required": false, "type": { "kind": "instance_of", @@ -87663,7 +91485,7 @@ } }, { - "name": "min", + "name": "min_gram", "required": false, "type": { "kind": "instance_of", @@ -87672,20 +91494,35 @@ "namespace": "_types" } } + }, + { + "name": "token_chars", + "required": false, + "serverDefault": [], + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TokenChar", + "namespace": "_types.analysis" + } + } + } } ], - "specLocation": "_types/analysis/token_filters.ts#L244-L248" + "specLocation": "_types/analysis/tokenizers.ts#L48-L57" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "LimitTokenCountTokenFilter", + "name": "KeywordTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -87694,53 +91531,34 @@ "required": true, "type": { "kind": "literal_value", - "value": "limit" - } - }, - { - "name": "consume_all_tokens", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "value": "keyword" } }, { - "name": "max_token_count", + "name": "buffer_size", "required": false, + "serverDefault": 256, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "_types/analysis/token_filters.ts#L250-L254" + "specLocation": "_types/analysis/tokenizers.ts#L68-L74" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "LowercaseTokenFilter", + "name": "LetterTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -87749,33 +91567,22 @@ "required": true, "type": { "kind": "literal_value", - "value": "lowercase" - } - }, - { - "name": "language", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "value": "letter" } } ], - "specLocation": "_types/analysis/token_filters.ts#L256-L259" + "specLocation": "_types/analysis/tokenizers.ts#L76-L78" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "MultiplexerTokenFilter", + "name": "LowercaseTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -87784,56 +91591,22 @@ "required": true, "type": { "kind": "literal_value", - "value": "multiplexer" - } - }, - { - "name": "filters", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "preserve_original", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], - "kind": "instance_of", - "type": { - "name": "Stringified", - "namespace": "_spec_utils" - } + "value": "lowercase" } } ], - "specLocation": "_types/analysis/token_filters.ts#L261-L265" + "specLocation": "_types/analysis/tokenizers.ts#L80-L82" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "NGramTokenFilter", + "name": "NGramTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -87846,18 +91619,18 @@ } }, { - "name": "max_gram", + "name": "custom_token_chars", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "min_gram", + "name": "max_gram", "required": false, "type": { "kind": "instance_of", @@ -87868,76 +91641,44 @@ } }, { - "name": "preserve_original", + "name": "min_gram", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L267-L272" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "NoriPartOfSpeechTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "nori_part_of_speech" - } }, { - "name": "stoptags", + "name": "token_chars", "required": false, + "serverDefault": [], "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TokenChar", + "namespace": "_types.analysis" } } } } ], - "specLocation": "_types/analysis/token_filters.ts#L274-L277" + "specLocation": "_types/analysis/tokenizers.ts#L84-L93" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "PatternCaptureTokenFilter", + "name": "PathHierarchyTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -87946,33 +91687,19 @@ "required": true, "type": { "kind": "literal_value", - "value": "pattern_capture" - } - }, - { - "name": "patterns", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "value": "path_hierarchy" } }, { - "name": "preserve_original", + "name": "buffer_size", "required": false, "type": { "generics": [ { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } ], @@ -87982,44 +91709,20 @@ "namespace": "_spec_utils" } } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L279-L283" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "PatternReplaceTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "pattern_replace" - } }, { - "name": "all", + "name": "delimiter", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "flags", + "name": "replacement", "required": false, "type": { "kind": "instance_of", @@ -88030,40 +91733,58 @@ } }, { - "name": "pattern", - "required": true, + "name": "reverse", + "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "name": "replacement", + "name": "skip", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } } ], - "specLocation": "_types/analysis/token_filters.ts#L285-L291" + "specLocation": "_types/analysis/tokenizers.ts#L95-L102" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "PorterStemTokenFilter", + "name": "PatternTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -88072,81 +91793,55 @@ "required": true, "type": { "kind": "literal_value", - "value": "porter_stem" + "value": "pattern" } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L293-L295" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "PredicateTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "flags", + "required": false, "type": { - "kind": "literal_value", - "value": "predicate_token_filter" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "script", - "required": true, + "name": "group", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "integer", "namespace": "_types" } } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L297-L300" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "RemoveDuplicatesTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "pattern", + "required": false, "type": { - "kind": "literal_value", - "value": "remove_duplicates" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } ], - "specLocation": "_types/analysis/token_filters.ts#L302-L304" + "specLocation": "_types/analysis/tokenizers.ts#L104-L109" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "ReverseTokenFilter", + "name": "SimplePatternTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -88155,22 +91850,33 @@ "required": true, "type": { "kind": "literal_value", - "value": "reverse" + "value": "simple_pattern" + } + }, + { + "name": "pattern", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } ], - "specLocation": "_types/analysis/token_filters.ts#L306-L308" + "specLocation": "_types/analysis/tokenizers.ts#L111-L114" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "ShingleTokenFilter", + "name": "SimplePatternSplitTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -88179,90 +91885,11 @@ "required": true, "type": { "kind": "literal_value", - "value": "shingle" - } - }, - { - "name": "filler_token", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "max_shingle_size", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "min_shingle_size", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "output_unigrams", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "output_unigrams_if_no_shingles", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "value": "simple_pattern_split" } }, { - "name": "token_separator", + "name": "pattern", "required": false, "type": { "kind": "instance_of", @@ -88273,18 +91900,18 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L86-L94" + "specLocation": "_types/analysis/tokenizers.ts#L116-L119" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "SnowballTokenFilter", + "name": "StandardTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -88293,33 +91920,33 @@ "required": true, "type": { "kind": "literal_value", - "value": "snowball" + "value": "standard" } }, { - "name": "language", + "name": "max_token_length", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SnowballLanguage", - "namespace": "_types.analysis" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "_types/analysis/token_filters.ts#L310-L313" + "specLocation": "_types/analysis/tokenizers.ts#L121-L124" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "StemmerOverrideTokenFilter", + "name": "ThaiTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -88328,47 +91955,22 @@ "required": true, "type": { "kind": "literal_value", - "value": "stemmer_override" - } - }, - { - "name": "rules", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "rules_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "value": "thai" } } ], - "specLocation": "_types/analysis/token_filters.ts#L315-L319" + "specLocation": "_types/analysis/tokenizers.ts#L126-L128" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "StemmerTokenFilter", + "name": "UaxEmailUrlTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -88377,36 +91979,33 @@ "required": true, "type": { "kind": "literal_value", - "value": "stemmer" + "value": "uax_url_email" } }, { - "aliases": [ - "name" - ], - "name": "language", + "name": "max_token_length", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "_types/analysis/token_filters.ts#L321-L325" + "specLocation": "_types/analysis/tokenizers.ts#L130-L133" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "StopTokenFilter", + "name": "WhitespaceTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -88415,45 +92014,47 @@ "required": true, "type": { "kind": "literal_value", - "value": "stop" - } - }, - { - "name": "ignore_case", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "value": "whitespace" } }, { - "name": "remove_trailing", + "name": "max_token_length", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/analysis/tokenizers.ts#L135-L138" + }, + { + "inherits": { + "type": { + "name": "TokenizerBase", + "namespace": "_types.analysis" + } + }, + "kind": "interface", + "name": { + "name": "IcuTokenizer", + "namespace": "_types.analysis" + }, + "properties": [ { - "name": "stopwords", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "StopWords", - "namespace": "_types.analysis" - } + "kind": "literal_value", + "value": "icu_tokenizer" } }, { - "name": "stopwords_path", - "required": false, + "name": "rule_files", + "required": true, "type": { "kind": "instance_of", "type": { @@ -88463,18 +92064,18 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L96-L102" + "specLocation": "_types/analysis/icu-plugin.ts#L30-L33" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "SynonymGraphTokenFilter", + "name": "KuromojiTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -88483,11 +92084,11 @@ "required": true, "type": { "kind": "literal_value", - "value": "synonym_graph" + "value": "kuromoji_tokenizer" } }, { - "name": "expand", + "name": "discard_punctuation", "required": false, "type": { "kind": "instance_of", @@ -88498,43 +92099,29 @@ } }, { - "name": "format", - "required": false, + "name": "mode", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SynonymFormat", + "name": "KuromojiTokenizationMode", "namespace": "_types.analysis" } } }, { - "name": "lenient", + "name": "nbest_cost", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "synonyms", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "integer", + "namespace": "_types" } } }, { - "name": "synonyms_path", + "name": "nbest_examples", "required": false, "type": { "kind": "instance_of", @@ -88545,7 +92132,7 @@ } }, { - "name": "synonyms_set", + "name": "user_dictionary", "required": false, "type": { "kind": "instance_of", @@ -88556,18 +92143,21 @@ } }, { - "name": "tokenizer", + "name": "user_dictionary_rules", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "updateable", + "name": "discard_compound_token", "required": false, "type": { "kind": "instance_of", @@ -88578,18 +92168,18 @@ } } ], - "specLocation": "_types/analysis/token_filters.ts#L109-L119" + "specLocation": "_types/analysis/kuromoji-plugin.ts#L58-L67" }, { "inherits": { "type": { - "name": "TokenFilterBase", + "name": "TokenizerBase", "namespace": "_types.analysis" } }, "kind": "interface", "name": { - "name": "SynonymTokenFilter", + "name": "NoriTokenizer", "namespace": "_types.analysis" }, "properties": [ @@ -88598,11 +92188,22 @@ "required": true, "type": { "kind": "literal_value", - "value": "synonym" + "value": "nori_tokenizer" } }, { - "name": "expand", + "name": "decompound_mode", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NoriDecompoundMode", + "namespace": "_types.analysis" + } + } + }, + { + "name": "discard_punctuation", "required": false, "type": { "kind": "instance_of", @@ -88613,603 +92214,621 @@ } }, { - "name": "format", + "name": "user_dictionary", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SynonymFormat", - "namespace": "_types.analysis" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "lenient", + "name": "user_dictionary_rules", "required": false, "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "_types/analysis/nori-plugin.ts#L28-L34" + }, + { + "kind": "enum", + "members": [ + { + "description": "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.", + "name": "bit" + }, + { + "description": "Indexes a 1-byte integer value per dimension.", + "name": "byte" + }, + { + "description": "Indexes a 4-byte floating-point value per dimension.", + "name": "float" + } + ], + "name": { + "name": "DenseVectorElementType", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/DenseVectorProperty.ts#L64-L80" + }, + { + "kind": "enum", + "members": [ + { + "description": "This utilizes a brute-force search algorithm for exact kNN search. This supports all `element_type` values.", + "name": "flat" + }, + { + "description": "This utilizes the HNSW algorithm for scalable approximate kNN search. This supports all `element_type` values.", + "name": "hnsw" + }, + { + "description": "This utilizes a brute-force search algorithm in addition to automatically half-byte scalar quantization.\nOnly supports `element_type` of `float`.", + "name": "int4_flat" + }, + { + "description": "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.", + "name": "int4_hnsw" + }, + { + "description": "This utilizes a brute-force search algorithm in addition to automatically scalar quantization. Only supports\n`element_type` of `float`.", + "name": "int8_flat" + }, + { + "description": "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.", + "name": "int8_hnsw" + } + ], + "name": { + "name": "DenseVectorIndexOptionsType", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/DenseVectorProperty.ts#L164-L197" + }, + { + "kind": "enum", + "members": [ + { + "description": "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.", + "name": "cosine" + }, + { + "description": "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.", + "name": "dot_product" + }, + { + "description": "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`.", + "name": "l2_norm" + }, + { + "description": "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`.", + "name": "max_inner_product" + } + ], + "name": { + "name": "DenseVectorSimilarity", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/DenseVectorProperty.ts#L82-L127" + }, + { + "esQuirk": "This is a boolean that evolved into an enum. Boolean values should be accepted on reading, and\ntrue and false must be serialized as JSON booleans, or it may break Kibana (see elasticsearch-java#139)", + "kind": "enum", + "members": [ + { + "name": "strict" + }, + { + "name": "runtime" + }, + { + "name": "true" + }, + { + "name": "false" + } + ], + "name": { + "name": "DynamicMapping", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/dynamic-template.ts#L50-L59" + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "RIGHT", + "counterclockwise", + "ccw" + ], + "name": "right" + }, + { + "aliases": [ + "LEFT", + "clockwise", + "cw" + ], + "name": "left" + } + ], + "name": { + "name": "GeoOrientation", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/geo.ts#L34-L39" + }, + { + "kind": "enum", + "members": [ + { + "name": "recursive" + }, + { + "name": "term" + } + ], + "name": { + "name": "GeoStrategy", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/geo.ts#L57-L60" + }, + { + "kind": "enum", + "members": [ + { + "name": "docs" + }, + { + "name": "freqs" + }, + { + "name": "positions" + }, + { + "name": "offsets" + } + ], + "name": { + "name": "IndexOptions", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/core.ts#L274-L279" + }, + { + "kind": "enum", + "members": [ + { + "name": "simple" + }, + { + "name": "regex" + } + ], + "name": { + "name": "MatchType", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/dynamic-template.ts#L45-L48" + }, + { + "kind": "enum", + "members": [ + { + "name": "fail" + }, + { + "name": "continue" + } + ], + "name": { + "name": "OnScriptError", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/core.ts#L141-L144" + }, + { + "kind": "type_alias", + "name": { + "name": "Property", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/Property.ts#L119-L189", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "BinaryProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "BooleanProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DynamicProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "JoinProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "KeywordProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MatchOnlyTextProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "PercolatorProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RankFeatureProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RankFeaturesProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SearchAsYouTypeProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "TextProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "VersionProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "WildcardProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DateNanosProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DateProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "AggregateMetricDoubleProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DenseVectorProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "FlattenedProperty", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "NestedProperty", + "namespace": "_types.mapping" + } + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "synonyms", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "ObjectProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "synonyms_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PassthroughObjectProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "synonyms_set", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SemanticTextProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "tokenizer", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SparseVectorProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "updateable", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "CompletionProperty", + "namespace": "_types.mapping" } - } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L121-L131" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "TrimTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "trim" - } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L327-L329" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "TruncateTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "truncate" - } - }, - { - "name": "length", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "ConstantKeywordProperty", + "namespace": "_types.mapping" } - } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L331-L334" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "UniqueTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "unique" - } - }, - { - "name": "only_on_same_position", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "CountedKeywordProperty", + "namespace": "_types.mapping" } - } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L336-L339" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "UppercaseTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "uppercase" - } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L341-L343" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "WordDelimiterGraphTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "word_delimiter_graph" - } - }, - { - "name": "adjust_offsets", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "FieldAliasProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "catenate_all", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "HistogramProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "catenate_numbers", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IpProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "catenate_words", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Murmur3HashProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "generate_number_parts", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "TokenCountProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "generate_word_parts", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "GeoPointProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "ignore_keywords", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "GeoShapeProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "preserve_original", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], + }, + { "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" - } - } - }, - { - "name": "protected_words", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "PointProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "protected_words_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ShapeProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "split_on_case_change", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ByteNumberProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "split_on_numerics", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DoubleNumberProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "stem_english_possessive", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "FloatNumberProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "type_table", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + }, + { + "kind": "instance_of", + "type": { + "name": "HalfFloatNumberProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "type_table_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IntegerNumberProperty", + "namespace": "_types.mapping" } - } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L150-L167" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "WordDelimiterTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "word_delimiter" - } - }, - { - "name": "catenate_all", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "LongNumberProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "catenate_numbers", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ScaledFloatNumberProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "catenate_words", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ShortNumberProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "generate_number_parts", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "UnsignedLongNumberProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "generate_word_parts", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DateRangeProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "preserve_original", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], + }, + { "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" - } - } - }, - { - "name": "protected_words", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "DoubleRangeProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "protected_words_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "FloatRangeProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "split_on_case_change", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IntegerRangeProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "split_on_numerics", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IpRangeProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "stem_english_possessive", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "type_table", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "LongRangeProperty", + "namespace": "_types.mapping" } - } - }, - { - "name": "type_table_path", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IcuCollationProperty", + "namespace": "_types.mapping" } } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L133-L148" + ], + "kind": "union_of" + }, + "variants": { + "defaultTag": "object", + "kind": "internal_tag", + "nonExhaustive": true, + "tag": "type" + } }, { "inherits": { "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "KuromojiStemmerTokenFilter", - "namespace": "_types.analysis" + "name": "BinaryProperty", + "namespace": "_types.mapping" }, "properties": [ { @@ -89217,47 +92836,28 @@ "required": true, "type": { "kind": "literal_value", - "value": "kuromoji_stemmer" - } - }, - { - "name": "minimum_length", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "value": "binary" } } ], - "specLocation": "_types/analysis/kuromoji-plugin.ts#L47-L50" + "specLocation": "_types/mapping/core.ts#L54-L56" }, { "inherits": { "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" + "name": "CorePropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "KuromojiReadingFormTokenFilter", - "namespace": "_types.analysis" + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" }, "properties": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "kuromoji_readingform" - } - }, - { - "name": "use_romaji", - "required": true, + "name": "doc_values", + "required": false, "type": { "kind": "instance_of", "type": { @@ -89267,283 +92867,296 @@ } } ], - "specLocation": "_types/analysis/kuromoji-plugin.ts#L42-L45" + "specLocation": "_types/mapping/core.ts#L50-L52" }, { "inherits": { "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" + "name": "PropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "KuromojiPartOfSpeechTokenFilter", - "namespace": "_types.analysis" + "name": "CorePropertyBase", + "namespace": "_types.mapping" }, "properties": [ { - "name": "type", - "required": true, + "name": "copy_to", + "required": false, "type": { - "kind": "literal_value", - "value": "kuromoji_part_of_speech" + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } } }, { - "name": "stoptags", - "required": true, + "name": "store", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "_types/analysis/kuromoji-plugin.ts#L37-L40" + "specLocation": "_types/mapping/core.ts#L45-L48" }, { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, "kind": "interface", "name": { - "name": "IcuCollationTokenFilter", - "namespace": "_types.analysis" + "name": "PropertyBase", + "namespace": "_types.mapping" }, "properties": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "icu_collation" - } - }, - { - "name": "alternate", + "description": "Metadata about the field.", + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "meta", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "IcuCollationAlternate", - "namespace": "_types.analysis" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "case_first", + "name": "properties", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "IcuCollationCaseFirst", - "namespace": "_types.analysis" + "key": { + "kind": "instance_of", + "type": { + "name": "PropertyName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Property", + "namespace": "_types.mapping" + } } } }, { - "name": "case_level", + "name": "ignore_above", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "country", + "name": "dynamic", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DynamicMapping", + "namespace": "_types.mapping" } } }, { - "name": "decomposition", + "name": "fields", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "IcuCollationDecomposition", - "namespace": "_types.analysis" + "key": { + "kind": "instance_of", + "type": { + "name": "PropertyName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Property", + "namespace": "_types.mapping" + } } } }, { - "name": "hiragana_quaternary_mode", + "name": "synthetic_source_keep", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "SyntheticSourceKeepEnum", + "namespace": "_types.mapping" } } + } + ], + "specLocation": "_types/mapping/Property.ts#L86-L97" + }, + { + "kind": "enum", + "members": [ + { + "description": "Synthetic source diverges from the original source (default)", + "name": "none" }, { - "name": "language", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "description": "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.", + "name": "arrays" }, { - "name": "numeric", + "description": "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.", + "name": "all" + } + ], + "name": { + "name": "SyntheticSourceKeepEnum", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/Property.ts#L99-L117" + }, + { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "BooleanProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "boost", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "name": "rules", + "name": "fielddata", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "NumericFielddata", + "namespace": "indices._types" } } }, { - "name": "strength", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IcuCollationStrength", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "variable_top", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "variant", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "boolean" } } ], - "specLocation": "_types/analysis/icu-plugin.ts#L51-L65" + "specLocation": "_types/mapping/core.ts#L58-L64" }, { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, "kind": "interface", "name": { - "name": "IcuFoldingTokenFilter", - "namespace": "_types.analysis" + "name": "NumericFielddata", + "namespace": "indices._types" }, "properties": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "icu_folding" - } - }, - { - "name": "unicode_set_filter", + "name": "format", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "NumericFielddataFormat", + "namespace": "indices._types" } } } ], - "specLocation": "_types/analysis/icu-plugin.ts#L46-L49" + "specLocation": "indices/_types/NumericFielddata.ts#L22-L24" }, { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "IcuNormalizationTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "icu_normalizer" - } + "name": "array" }, { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuNormalizationType", - "namespace": "_types.analysis" - } - } + "name": "disabled" } ], - "specLocation": "_types/analysis/icu-plugin.ts#L35-L38" + "name": { + "name": "NumericFielddataFormat", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/NumericFielddataFormat.ts#L20-L23" }, { "inherits": { "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "IcuTransformTokenFilter", - "namespace": "_types.analysis" + "name": "DynamicProperty", + "namespace": "_types.mapping" }, "properties": [ { @@ -89551,116 +93164,77 @@ "required": true, "type": { "kind": "literal_value", - "value": "icu_transform" + "value": "{dynamic_type}" } }, { - "name": "dir", + "name": "enabled", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IcuTransformDirection", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "id", - "required": true, + "name": "null_value", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "FieldValue", + "namespace": "_types" } } - } - ], - "specLocation": "_types/analysis/icu-plugin.ts#L24-L28" - }, - { - "inherits": { - "type": { - "name": "TokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "PhoneticTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "phonetic" - } }, { - "name": "encoder", - "required": true, + "name": "boost", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "PhoneticEncoder", - "namespace": "_types.analysis" + "name": "double", + "namespace": "_types" } } }, { - "name": "languageset", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "PhoneticLanguage", - "namespace": "_types.analysis" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "PhoneticLanguage", - "namespace": "_types.analysis" - } - } - } - ], - "kind": "union_of" - } - }, - { - "name": "max_code_len", + "name": "coerce", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", "namespace": "_types" } } }, { - "name": "name_type", + "name": "on_script_error", "required": false, "type": { "kind": "instance_of", "type": { - "name": "PhoneticNameType", - "namespace": "_types.analysis" + "name": "OnScriptError", + "namespace": "_types.mapping" } } }, { - "name": "replace", + "name": "ignore_malformed", "required": false, "type": { "kind": "instance_of", @@ -89671,257 +93245,107 @@ } }, { - "name": "rule_type", + "name": "time_series_metric", "required": false, "type": { "kind": "instance_of", "type": { - "name": "PhoneticRuleType", - "namespace": "_types.analysis" + "name": "TimeSeriesMetricType", + "namespace": "_types.mapping" } } - } - ], - "specLocation": "_types/analysis/phonetic-plugin.ts#L64-L72" - }, - { - "inherits": { - "type": { - "name": "CompoundWordTokenFilterBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "DictionaryDecompounderTokenFilter", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "analyzer", + "required": false, "type": { - "kind": "literal_value", - "value": "dictionary_decompounder" - } - } - ], - "specLocation": "_types/analysis/token_filters.ts#L53-L55" - }, - { - "codegenNames": [ - "name", - "definition" - ], - "extDocId": "analysis-tokenizers", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", - "kind": "type_alias", - "name": { - "name": "Tokenizer", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/tokenizers.ts#L140-L145", - "type": { - "items": [ - { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - }, - { - "kind": "instance_of", - "type": { - "name": "TokenizerDefinition", - "namespace": "_types.analysis" - } } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "TokenizerDefinition", - "namespace": "_types.analysis" - }, - "specLocation": "_types/analysis/tokenizers.ts#L147-L170", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "CharGroupTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ClassicTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "EdgeNGramTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "KeywordTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "LetterTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "LowercaseTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "NGramTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "PathHierarchyTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "PatternTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SimplePatternTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SimplePatternSplitTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StandardTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ThaiTokenizer", - "namespace": "_types.analysis" - } - }, - { - "kind": "instance_of", - "type": { - "name": "UaxEmailUrlTokenizer", - "namespace": "_types.analysis" - } - }, - { + }, + { + "name": "eager_global_ordinals", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "WhitespaceTokenizer", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "index", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IcuTokenizer", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "index_options", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "KuromojiTokenizer", - "namespace": "_types.analysis" + "name": "IndexOptions", + "namespace": "_types.mapping" } - }, - { + } + }, + { + "name": "index_phrases", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "NoriTokenizer", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } } - ], - "kind": "union_of" - }, - "variants": { - "kind": "internal_tag", - "nonExhaustive": true, - "tag": "type" - } - }, - { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "CharGroupTokenizer", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "index_prefixes", + "required": false, "type": { - "kind": "literal_value", - "value": "char_group" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "TextIndexPrefixes", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "tokenize_on_chars", - "required": true, + "name": "norms", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "max_token_length", + "name": "position_increment_gap", "required": false, "type": { "kind": "instance_of", @@ -89930,111 +93354,53 @@ "namespace": "_types" } } - } - ], - "specLocation": "_types/analysis/tokenizers.ts#L31-L38" - }, - { - "kind": "interface", - "name": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "version", + "name": "search_analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/analysis/tokenizers.ts#L27-L29" - }, - { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "ClassicTokenizer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "classic" - } }, { - "name": "max_token_length", + "name": "search_quote_analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/analysis/tokenizers.ts#L40-L46" - }, - { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "EdgeNGramTokenizer", - "namespace": "_types.analysis" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "edge_ngram" - } }, { - "name": "custom_token_chars", + "name": "term_vector", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TermVectorOption", + "namespace": "_types.mapping" } } }, { - "name": "max_gram", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "min_gram", + "name": "precision_step", "required": false, "type": { "kind": "instance_of", @@ -90045,48 +93411,65 @@ } }, { - "name": "token_chars", + "name": "locale", "required": false, - "serverDefault": [], "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TokenChar", - "namespace": "_types.analysis" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/analysis/tokenizers.ts#L48-L57" + "specLocation": "_types/mapping/core.ts#L318-L349" }, { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" + "kind": "enum", + "members": [ + { + "name": "gauge" + }, + { + "name": "counter" + }, + { + "name": "summary" + }, + { + "name": "histogram" + }, + { + "name": "position" } + ], + "name": { + "name": "TimeSeriesMetricType", + "namespace": "_types.mapping" }, + "specLocation": "_types/mapping/TimeSeriesMetricType.ts#L20-L26" + }, + { "kind": "interface", "name": { - "name": "KeywordTokenizer", - "namespace": "_types.analysis" + "name": "TextIndexPrefixes", + "namespace": "_types.mapping" }, "properties": [ { - "name": "type", + "name": "max_chars", "required": true, "type": { - "kind": "literal_value", - "value": "keyword" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } }, { - "name": "buffer_size", - "required": false, - "serverDefault": 256, + "name": "min_chars", + "required": true, "type": { "kind": "instance_of", "type": { @@ -90096,182 +93479,214 @@ } } ], - "specLocation": "_types/analysis/tokenizers.ts#L68-L74" + "specLocation": "_types/mapping/core.ts#L281-L284" + }, + { + "kind": "enum", + "members": [ + { + "name": "no" + }, + { + "name": "yes" + }, + { + "name": "with_offsets" + }, + { + "name": "with_positions" + }, + { + "name": "with_positions_offsets" + }, + { + "name": "with_positions_offsets_payloads" + }, + { + "name": "with_positions_payloads" + } + ], + "name": { + "name": "TermVectorOption", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/TermVectorOption.ts#L20-L28" }, { "inherits": { "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" + "name": "PropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "LetterTokenizer", - "namespace": "_types.analysis" + "name": "JoinProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "type", - "required": true, + "name": "relations", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "RelationName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "RelationName", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "RelationName", + "namespace": "_types" + } + } + } + ], + "kind": "union_of" + } + } + }, + { + "name": "eager_global_ordinals", + "required": false, "type": { - "kind": "literal_value", - "value": "letter" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } - } - ], - "specLocation": "_types/analysis/tokenizers.ts#L76-L78" - }, - { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "LowercaseTokenizer", - "namespace": "_types.analysis" - }, - "properties": [ + }, { "name": "type", "required": true, "type": { "kind": "literal_value", - "value": "lowercase" + "value": "join" } } ], - "specLocation": "_types/analysis/tokenizers.ts#L80-L82" + "specLocation": "_types/mapping/core.ts#L92-L96" }, { "inherits": { "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "NGramTokenizer", - "namespace": "_types.analysis" + "name": "KeywordProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "type", - "required": true, + "name": "boost", + "required": false, "type": { - "kind": "literal_value", - "value": "ngram" + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } }, { - "name": "custom_token_chars", + "name": "eager_global_ordinals", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "max_gram", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "min_gram", + "name": "index_options", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IndexOptions", + "namespace": "_types.mapping" } } }, { - "name": "token_chars", + "name": "script", "required": false, - "serverDefault": [], "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TokenChar", - "namespace": "_types.analysis" - } + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" } } - } - ], - "specLocation": "_types/analysis/tokenizers.ts#L84-L93" - }, - { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "PathHierarchyTokenizer", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "on_script_error", + "required": false, "type": { - "kind": "literal_value", - "value": "path_hierarchy" + "kind": "instance_of", + "type": { + "name": "OnScriptError", + "namespace": "_types.mapping" + } } }, { - "name": "buffer_size", + "name": "normalizer", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "delimiter", + "name": "norms", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "replacement", + "name": "null_value", "required": false, "type": { "kind": "instance_of", @@ -90282,59 +93697,76 @@ } }, { - "name": "reverse", + "name": "similarity", "required": false, "type": { - "generics": [ + "items": [ { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", "namespace": "_builtins" } } ], + "kind": "union_of" + } + }, + { + "name": "split_queries_on_whitespace", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "skip", + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "stability": "experimental" + } + }, + "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "name": "time_series_dimension", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "boolean", + "namespace": "_builtins" } } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "keyword" + } } ], - "specLocation": "_types/analysis/tokenizers.ts#L95-L102" + "specLocation": "_types/mapping/core.ts#L98-L117" }, { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - } - }, + "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.", "kind": "interface", "name": { - "name": "PatternTokenizer", - "namespace": "_types.analysis" + "name": "MatchOnlyTextProperty", + "namespace": "_types.mapping" }, "properties": [ { @@ -90342,56 +93774,85 @@ "required": true, "type": { "kind": "literal_value", - "value": "pattern" + "value": "match_only_text" } }, { - "name": "flags", + "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.", + "docId": "multi-fields", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-fields.html", + "name": "fields", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "PropertyName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Property", + "namespace": "_types.mapping" + } } } }, { - "name": "group", + "description": "Metadata about the field.", + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "meta", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "pattern", + "description": "Allows you to copy the values of multiple fields into a group\nfield, which can then be queried as a single field.", + "name": "copy_to", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Fields", + "namespace": "_types" } } } ], - "specLocation": "_types/analysis/tokenizers.ts#L104-L109" + "specLocation": "_types/mapping/core.ts#L247-L272" }, { "inherits": { "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" + "name": "PropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "SimplePatternTokenizer", - "namespace": "_types.analysis" + "name": "PercolatorProperty", + "namespace": "_types.mapping" }, "properties": [ { @@ -90399,175 +93860,130 @@ "required": true, "type": { "kind": "literal_value", - "value": "simple_pattern" - } - }, - { - "name": "pattern", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "value": "percolator" } } ], - "specLocation": "_types/analysis/tokenizers.ts#L111-L114" + "specLocation": "_types/mapping/core.ts#L192-L194" }, { "inherits": { "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" + "name": "PropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "SimplePatternSplitTokenizer", - "namespace": "_types.analysis" + "name": "RankFeatureProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "simple_pattern_split" - } - }, - { - "name": "pattern", + "name": "positive_score_impact", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "rank_feature" + } } ], - "specLocation": "_types/analysis/tokenizers.ts#L116-L119" + "specLocation": "_types/mapping/core.ts#L196-L199" }, { "inherits": { "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" + "name": "PropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "StandardTokenizer", - "namespace": "_types.analysis" + "name": "RankFeaturesProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "standard" - } - }, - { - "name": "max_token_length", + "name": "positive_score_impact", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/analysis/tokenizers.ts#L121-L124" - }, - { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "ThaiTokenizer", - "namespace": "_types.analysis" - }, - "properties": [ + }, { "name": "type", "required": true, "type": { "kind": "literal_value", - "value": "thai" + "value": "rank_features" } } ], - "specLocation": "_types/analysis/tokenizers.ts#L126-L128" + "specLocation": "_types/mapping/core.ts#L201-L204" }, { "inherits": { "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" + "name": "CorePropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "UaxEmailUrlTokenizer", - "namespace": "_types.analysis" + "name": "SearchAsYouTypeProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "type", - "required": true, + "name": "analyzer", + "required": false, "type": { - "kind": "literal_value", - "value": "uax_url_email" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "max_token_length", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/analysis/tokenizers.ts#L130-L133" - }, - { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "WhitespaceTokenizer", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "index_options", + "required": false, "type": { - "kind": "literal_value", - "value": "whitespace" + "kind": "instance_of", + "type": { + "name": "IndexOptions", + "namespace": "_types.mapping" + } } }, { - "name": "max_token_length", + "name": "max_shingle_size", "required": false, "type": { "kind": "instance_of", @@ -90576,137 +93992,177 @@ "namespace": "_types" } } - } - ], - "specLocation": "_types/analysis/tokenizers.ts#L135-L138" - }, - { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "IcuTokenizer", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "norms", + "required": false, "type": { - "kind": "literal_value", - "value": "icu_tokenizer" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "search_analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "search_quote_analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "similarity", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "term_vector", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TermVectorOption", + "namespace": "_types.mapping" + } } }, { - "name": "rule_files", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "search_as_you_type" } } ], - "specLocation": "_types/analysis/icu-plugin.ts#L30-L33" + "specLocation": "_types/mapping/core.ts#L228-L239" }, { "inherits": { "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" + "name": "CorePropertyBase", + "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "KuromojiTokenizer", - "namespace": "_types.analysis" + "name": "TextProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "type", - "required": true, + "name": "analyzer", + "required": false, "type": { - "kind": "literal_value", - "value": "kuromoji_tokenizer" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "discard_punctuation", + "name": "boost", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } }, { - "name": "mode", - "required": true, + "name": "eager_global_ordinals", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "KuromojiTokenizationMode", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "nbest_cost", + "name": "fielddata", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "nbest_examples", + "name": "fielddata_frequency_filter", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "FielddataFrequencyFilter", + "namespace": "indices._types" } } }, { - "name": "user_dictionary", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "user_dictionary_rules", + "name": "index_options", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "IndexOptions", + "namespace": "_types.mapping" } } }, { - "name": "discard_compound_token", + "name": "index_phrases", "required": false, "type": { "kind": "instance_of", @@ -90715,55 +94171,54 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "_types/analysis/kuromoji-plugin.ts#L58-L67" - }, - { - "inherits": { - "type": { - "name": "TokenizerBase", - "namespace": "_types.analysis" - } - }, - "kind": "interface", - "name": { - "name": "NoriTokenizer", - "namespace": "_types.analysis" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "index_prefixes", + "required": false, "type": { - "kind": "literal_value", - "value": "nori_tokenizer" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "TextIndexPrefixes", + "namespace": "_types.mapping" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "decompound_mode", + "name": "norms", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NoriDecompoundMode", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "discard_punctuation", + "name": "position_increment_gap", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "user_dictionary", + "name": "search_analyzer", "required": false, "type": { "kind": "instance_of", @@ -90774,622 +94229,800 @@ } }, { - "name": "user_dictionary_rules", + "name": "search_quote_analyzer", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/analysis/nori-plugin.ts#L28-L34" - }, - { - "kind": "enum", - "members": [ - { - "description": "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.", - "name": "bit" - }, - { - "description": "Indexes a 1-byte integer value per dimension.", - "name": "byte" - }, - { - "description": "Indexes a 4-byte floating-point value per dimension.", - "name": "float" - } - ], - "name": { - "name": "DenseVectorElementType", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/DenseVectorProperty.ts#L64-L80" - }, - { - "kind": "enum", - "members": [ - { - "description": "This utilizes a brute-force search algorithm for exact kNN search. This supports all `element_type` values.", - "name": "flat" - }, - { - "description": "This utilizes the HNSW algorithm for scalable approximate kNN search. This supports all `element_type` values.", - "name": "hnsw" - }, - { - "description": "This utilizes a brute-force search algorithm in addition to automatically half-byte scalar quantization.\nOnly supports `element_type` of `float`.", - "name": "int4_flat" }, { - "description": "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.", - "name": "int4_hnsw" + "name": "similarity", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } }, { - "description": "This utilizes a brute-force search algorithm in addition to automatically scalar quantization. Only supports\n`element_type` of `float`.", - "name": "int8_flat" + "name": "term_vector", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TermVectorOption", + "namespace": "_types.mapping" + } + } }, { - "description": "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.", - "name": "int8_hnsw" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "text" + } } ], - "name": { - "name": "DenseVectorIndexOptionsType", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/DenseVectorProperty.ts#L164-L197" + "specLocation": "_types/mapping/core.ts#L286-L303" }, { - "kind": "enum", - "members": [ - { - "description": "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.", - "name": "cosine" - }, - { - "description": "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.", - "name": "dot_product" - }, - { - "description": "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`.", - "name": "l2_norm" - }, - { - "description": "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`.", - "name": "max_inner_product" - } - ], + "kind": "interface", "name": { - "name": "DenseVectorSimilarity", - "namespace": "_types.mapping" + "name": "FielddataFrequencyFilter", + "namespace": "indices._types" }, - "specLocation": "_types/mapping/DenseVectorProperty.ts#L82-L127" - }, - { - "esQuirk": "This is a boolean that evolved into an enum. Boolean values should be accepted on reading, and\ntrue and false must be serialized as JSON booleans, or it may break Kibana (see elasticsearch-java#139)", - "kind": "enum", - "members": [ - { - "name": "strict" - }, + "properties": [ { - "name": "runtime" + "name": "max", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } }, { - "name": "true" + "name": "min", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } }, { - "name": "false" + "name": "min_segment_size", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } ], - "name": { - "name": "DynamicMapping", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/dynamic-template.ts#L50-L59" + "specLocation": "indices/_types/FielddataFrequencyFilter.ts#L22-L26" }, { - "kind": "enum", - "members": [ - { - "aliases": [ - "RIGHT", - "counterclockwise", - "ccw" - ], - "name": "right" - }, - { - "aliases": [ - "LEFT", - "clockwise", - "cw" - ], - "name": "left" + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" } - ], - "name": { - "name": "GeoOrientation", - "namespace": "_types.mapping" }, - "specLocation": "_types/mapping/geo.ts#L34-L39" - }, - { - "kind": "enum", - "members": [ - { - "name": "recursive" - }, - { - "name": "term" - } - ], + "kind": "interface", "name": { - "name": "GeoStrategy", + "name": "VersionProperty", "namespace": "_types.mapping" }, - "specLocation": "_types/mapping/geo.ts#L57-L60" - }, - { - "kind": "enum", - "members": [ - { - "name": "docs" - }, - { - "name": "freqs" - }, - { - "name": "positions" - }, + "properties": [ { - "name": "offsets" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "version" + } } ], - "name": { - "name": "IndexOptions", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/core.ts#L274-L279" + "specLocation": "_types/mapping/core.ts#L305-L307" }, { - "kind": "enum", - "members": [ - { - "name": "simple" - }, - { - "name": "regex" + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" } - ], + }, + "kind": "interface", "name": { - "name": "MatchType", + "name": "WildcardProperty", "namespace": "_types.mapping" }, - "specLocation": "_types/mapping/dynamic-template.ts#L45-L48" - }, - { - "kind": "enum", - "members": [ + "properties": [ { - "name": "fail" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "wildcard" + } }, { - "name": "continue" - } - ], - "name": { - "name": "OnScriptError", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/core.ts#L141-L144" - }, - { - "kind": "type_alias", - "name": { - "name": "Property", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/Property.ts#L119-L189", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "BinaryProperty", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "BooleanProperty", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DynamicProperty", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "JoinProperty", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "KeywordProperty", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "MatchOnlyTextProperty", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "PercolatorProperty", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "RankFeatureProperty", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "RankFeaturesProperty", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SearchAsYouTypeProperty", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "TextProperty", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "VersionProperty", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "WildcardProperty", - "namespace": "_types.mapping" + "availability": { + "serverless": {}, + "stack": { + "since": "7.15.0" } }, - { + "name": "null_value", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DateNanosProperty", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } - }, - { + } + } + ], + "specLocation": "_types/mapping/core.ts#L309-L316" + }, + { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "DateNanosProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "boost", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DateProperty", - "namespace": "_types.mapping" + "name": "double", + "namespace": "_types" } - }, - { + } + }, + { + "name": "format", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "AggregateMetricDoubleProperty", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "ignore_malformed", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DenseVectorProperty", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "index", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "FlattenedProperty", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "script", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "NestedProperty", - "namespace": "_types.mapping" + "name": "Script", + "namespace": "_types" } - }, - { + } + }, + { + "name": "on_script_error", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ObjectProperty", + "name": "OnScriptError", "namespace": "_types.mapping" } - }, - { + } + }, + { + "name": "null_value", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "PassthroughObjectProperty", - "namespace": "_types.mapping" + "name": "DateTime", + "namespace": "_types" } - }, - { + } + }, + { + "name": "precision_step", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SemanticTextProperty", - "namespace": "_types.mapping" + "name": "integer", + "namespace": "_types" } - }, - { + } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "date_nanos" + } + } + ], + "specLocation": "_types/mapping/core.ts#L80-L90" + }, + { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "DateProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "boost", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "SparseVectorProperty", - "namespace": "_types.mapping" + "name": "double", + "namespace": "_types" } - }, - { + } + }, + { + "name": "fielddata", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CompletionProperty", - "namespace": "_types.mapping" + "name": "NumericFielddata", + "namespace": "indices._types" } - }, - { + } + }, + { + "name": "format", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ConstantKeywordProperty", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "ignore_malformed", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CountedKeywordProperty", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "index", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "FieldAliasProperty", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "script", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "HistogramProperty", - "namespace": "_types.mapping" + "name": "Script", + "namespace": "_types" } - }, - { + } + }, + { + "name": "on_script_error", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IpProperty", + "name": "OnScriptError", "namespace": "_types.mapping" } - }, - { + } + }, + { + "name": "null_value", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "Murmur3HashProperty", - "namespace": "_types.mapping" + "name": "DateTime", + "namespace": "_types" } - }, - { + } + }, + { + "name": "precision_step", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "TokenCountProperty", - "namespace": "_types.mapping" + "name": "integer", + "namespace": "_types" } - }, - { + } + }, + { + "name": "locale", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "GeoPointProperty", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "date" + } + } + ], + "specLocation": "_types/mapping/core.ts#L66-L78" + }, + { + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "AggregateMetricDoubleProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "aggregate_metric_double" + } + }, + { + "name": "default_metric", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "GeoShapeProperty", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "metrics", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "time_series_metric", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "PointProperty", + "name": "TimeSeriesMetricType", "namespace": "_types.mapping" } - }, - { + } + } + ], + "specLocation": "_types/mapping/complex.ts#L59-L64" + }, + { + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "DenseVectorProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "dense_vector" + } + }, + { + "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.", + "name": "dims", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "ShapeProperty", - "namespace": "_types.mapping" + "name": "integer", + "namespace": "_types" } - }, - { + } + }, + { + "description": "The data type used to encode vectors. The supported data types are `float` (default), `byte`, and `bit`.", + "name": "element_type", + "required": false, + "serverDefault": "float", + "type": { "kind": "instance_of", "type": { - "name": "ByteNumberProperty", + "name": "DenseVectorElementType", "namespace": "_types.mapping" } - }, - { + } + }, + { + "description": "If `true`, you can search this field using the kNN search API.", + "name": "index", + "required": false, + "serverDefault": true, + "type": { "kind": "instance_of", "type": { - "name": "DoubleNumberProperty", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "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`.", + "name": "index_options", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "FloatNumberProperty", + "name": "DenseVectorIndexOptions", "namespace": "_types.mapping" } - }, - { + } + }, + { + "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`.", + "name": "similarity", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "HalfFloatNumberProperty", + "name": "DenseVectorSimilarity", "namespace": "_types.mapping" } - }, - { + } + } + ], + "specLocation": "_types/mapping/DenseVectorProperty.ts#L23-L62" + }, + { + "kind": "interface", + "name": { + "name": "DenseVectorIndexOptions", + "namespace": "_types.mapping" + }, + "properties": [ + { + "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.", + "name": "confidence_interval", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IntegerNumberProperty", - "namespace": "_types.mapping" + "name": "float", + "namespace": "_types" } - }, - { + } + }, + { + "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`, and `int4_hnsw` index types.", + "name": "ef_construction", + "required": false, + "serverDefault": 100, + "type": { "kind": "instance_of", "type": { - "name": "LongNumberProperty", - "namespace": "_types.mapping" + "name": "integer", + "namespace": "_types" } - }, - { + } + }, + { + "description": "The number of neighbors each node will be connected to in the HNSW graph.\n\nOnly applicable to `hnsw`, `int8_hnsw`, and `int4_hnsw` index types.", + "name": "m", + "required": false, + "serverDefault": 16, + "type": { "kind": "instance_of", "type": { - "name": "ScaledFloatNumberProperty", - "namespace": "_types.mapping" + "name": "integer", + "namespace": "_types" } - }, - { + } + }, + { + "description": "The type of kNN algorithm to use.", + "name": "type", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "ShortNumberProperty", + "name": "DenseVectorIndexOptionsType", "namespace": "_types.mapping" } - }, - { + } + } + ], + "specLocation": "_types/mapping/DenseVectorProperty.ts#L129-L162" + }, + { + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "FlattenedProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "boost", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "UnsignedLongNumberProperty", - "namespace": "_types.mapping" + "name": "double", + "namespace": "_types" } - }, - { + } + }, + { + "name": "depth_limit", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "doc_values", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DateRangeProperty", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "eager_global_ordinals", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "DoubleRangeProperty", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "index", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "FloatRangeProperty", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "index_options", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IntegerRangeProperty", + "name": "IndexOptions", "namespace": "_types.mapping" } - }, - { + } + }, + { + "name": "null_value", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IpRangeProperty", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "similarity", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "LongRangeProperty", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } - }, - { + } + }, + { + "name": "split_queries_on_whitespace", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "IcuCollationProperty", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } } - ], - "kind": "union_of" - }, - "variants": { - "defaultTag": "object", - "kind": "internal_tag", - "nonExhaustive": true, - "tag": "type" - } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "flattened" + } + } + ], + "specLocation": "_types/mapping/complex.ts#L26-L37" }, { "inherits": { "type": { - "name": "DocValuesPropertyBase", + "name": "CorePropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "BinaryProperty", + "name": "NestedProperty", "namespace": "_types.mapping" }, "properties": [ + { + "name": "enabled", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "include_in_parent", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "include_in_root", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, { "name": "type", "required": true, "type": { "kind": "literal_value", - "value": "binary" + "value": "nested" } } ], - "specLocation": "_types/mapping/core.ts#L54-L56" + "specLocation": "_types/mapping/complex.ts#L39-L44" }, { "inherits": { @@ -91400,12 +95033,12 @@ }, "kind": "interface", "name": { - "name": "DocValuesPropertyBase", + "name": "ObjectProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "doc_values", + "name": "enabled", "required": false, "type": { "kind": "instance_of", @@ -91414,36 +95047,91 @@ "namespace": "_builtins" } } + }, + { + "name": "subobjects", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Subobjects", + "namespace": "_types.mapping" + } + } + }, + { + "name": "type", + "required": false, + "type": { + "kind": "literal_value", + "value": "object" + } } ], - "specLocation": "_types/mapping/core.ts#L50-L52" + "specLocation": "_types/mapping/complex.ts#L46-L50" + }, + { + "esQuirk": "This enum is a boolean that evolved into a tri-state enum. True and False have\nto be (de)serialized as JSON booleans.", + "kind": "enum", + "members": [ + { + "name": "true" + }, + { + "name": "false" + } + ], + "name": { + "name": "Subobjects", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/TypeMapping.ts#L63-L74" }, { "inherits": { "type": { - "name": "PropertyBase", + "name": "CorePropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "CorePropertyBase", + "name": "PassthroughObjectProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "copy_to", + "name": "type", + "required": false, + "type": { + "kind": "literal_value", + "value": "passthrough" + } + }, + { + "name": "enabled", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "priority", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", "namespace": "_types" } } }, { - "name": "store", + "name": "time_series_dimension", "required": false, "type": { "kind": "instance_of", @@ -91454,19 +95142,24 @@ } } ], - "specLocation": "_types/mapping/core.ts#L45-L48" + "specLocation": "_types/mapping/complex.ts#L52-L57" }, { "kind": "interface", "name": { - "name": "PropertyBase", + "name": "SemanticTextProperty", "namespace": "_types.mapping" }, "properties": [ { - "description": "Metadata about the field.", - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "semantic_text" + } + }, + { "name": "meta", "required": false, "type": { @@ -91489,29 +95182,97 @@ } }, { - "name": "properties", + "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.", + "name": "inference_id", "required": false, + "serverDefault": ".elser-2-elasticsearch", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "PropertyName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "search_inference_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/mapping/core.ts#L210-L226" + }, + { + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "SparseVectorProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "sparse_vector" + } + } + ], + "specLocation": "_types/mapping/core.ts#L206-L208" + }, + { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "CompletionProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "contexts", + "required": false, + "type": { + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "Property", + "name": "SuggestContext", "namespace": "_types.mapping" } } } }, { - "name": "ignore_above", + "name": "max_input_length", "required": false, "type": { "kind": "instance_of", @@ -91522,73 +95283,250 @@ } }, { - "name": "dynamic", + "name": "preserve_position_increments", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DynamicMapping", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "fields", + "name": "preserve_separators", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "PropertyName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Property", - "namespace": "_types.mapping" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "search_analyzer", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "completion" + } + } + ], + "specLocation": "_types/mapping/specialized.ts#L33-L41" + }, + { + "kind": "interface", + "name": { + "name": "SuggestContext", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "synthetic_source_keep", + "name": "precision", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "_types/mapping/specialized.ts#L43-L48" + }, + { + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "ConstantKeywordProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "value", + "required": false, + "type": { + "kind": "user_defined_value" + } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "constant_keyword" + } + } + ], + "specLocation": "_types/mapping/specialized.ts#L50-L53" + }, + { + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "CountedKeywordProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "counted_keyword" + } + }, + { + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/mapping/specialized.ts#L55-L62" + }, + { + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "FieldAliasProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "path", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SyntheticSourceKeepEnum", - "namespace": "_types.mapping" + "name": "Field", + "namespace": "_types" } } + }, + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "alias" + } } ], - "specLocation": "_types/mapping/Property.ts#L86-L97" + "specLocation": "_types/mapping/specialized.ts#L64-L67" }, { - "kind": "enum", - "members": [ - { - "description": "Synthetic source diverges from the original source (default)", - "name": "none" - }, + "inherits": { + "type": { + "name": "PropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "HistogramProperty", + "namespace": "_types.mapping" + }, + "properties": [ { - "description": "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.", - "name": "arrays" + "name": "ignore_malformed", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "description": "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.", - "name": "all" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "histogram" + } } ], - "name": { - "name": "SyntheticSourceKeepEnum", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/Property.ts#L99-L117" + "specLocation": "_types/mapping/specialized.ts#L69-L72" }, { "inherits": { @@ -91599,7 +95537,7 @@ }, "kind": "interface", "name": { - "name": "BooleanProperty", + "name": "IpProperty", "namespace": "_types.mapping" }, "properties": [ @@ -91615,18 +95553,18 @@ } }, { - "name": "fielddata", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NumericFielddata", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "index", + "name": "ignore_malformed", "required": false, "type": { "kind": "instance_of", @@ -91639,6 +95577,48 @@ { "name": "null_value", "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "on_script_error", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "OnScriptError", + "namespace": "_types.mapping" + } + } + }, + { + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } + }, + { + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "stability": "experimental" + } + }, + "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "name": "time_series_dimension", + "required": false, "type": { "kind": "instance_of", "type": { @@ -91652,48 +95632,35 @@ "required": true, "type": { "kind": "literal_value", - "value": "boolean" + "value": "ip" } } ], - "specLocation": "_types/mapping/core.ts#L58-L64" + "specLocation": "_types/mapping/specialized.ts#L74-L88" }, { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, "kind": "interface", "name": { - "name": "NumericFielddata", - "namespace": "indices._types" + "name": "Murmur3HashProperty", + "namespace": "_types.mapping" }, "properties": [ { - "name": "format", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "NumericFielddataFormat", - "namespace": "indices._types" - } + "kind": "literal_value", + "value": "murmur3" } } ], - "specLocation": "indices/_types/NumericFielddata.ts#L22-L24" - }, - { - "kind": "enum", - "members": [ - { - "name": "array" - }, - { - "name": "disabled" - } - ], - "name": { - "name": "NumericFielddataFormat", - "namespace": "indices._types" - }, - "specLocation": "indices/_types/NumericFielddataFormat.ts#L20-L23" + "specLocation": "_types/mapping/specialized.ts#L90-L92" }, { "inherits": { @@ -91704,40 +95671,21 @@ }, "kind": "interface", "name": { - "name": "DynamicProperty", + "name": "TokenCountProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "{dynamic_type}" - } - }, - { - "name": "enabled", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, - { - "name": "null_value", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FieldValue", - "namespace": "_types" - } - } - }, { "name": "boost", "required": false, @@ -91750,7 +95698,7 @@ } }, { - "name": "coerce", + "name": "index", "required": false, "type": { "kind": "instance_of", @@ -91761,27 +95709,51 @@ } }, { - "name": "script", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "double", "namespace": "_types" } } }, { - "name": "on_script_error", + "name": "enable_position_increments", "required": false, "type": { "kind": "instance_of", "type": { - "name": "OnScriptError", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } } }, + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "token_count" + } + } + ], + "specLocation": "_types/mapping/specialized.ts#L94-L101" + }, + { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "GeoPointProperty", + "namespace": "_types.mapping" + }, + "properties": [ { "name": "ignore_malformed", "required": false, @@ -91794,29 +95766,29 @@ } }, { - "name": "time_series_metric", + "name": "ignore_z_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TimeSeriesMetricType", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "analyzer", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "GeoLocation", + "namespace": "_types" } } }, { - "name": "eager_global_ordinals", + "name": "index", "required": false, "type": { "kind": "instance_of", @@ -91827,29 +95799,56 @@ } }, { - "name": "index", + "name": "on_script_error", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "OnScriptError", + "namespace": "_types.mapping" } } }, { - "name": "index_options", + "name": "script", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexOptions", - "namespace": "_types.mapping" + "name": "Script", + "namespace": "_types" } } }, { - "name": "index_phrases", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "geo_point" + } + } + ], + "specLocation": "_types/mapping/geo.ts#L24-L32" + }, + { + "description": "The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles\nand polygons.", + "docId": "geo-shape", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html", + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "GeoShapeProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "coerce", "required": false, "type": { "kind": "instance_of", @@ -91860,30 +95859,7 @@ } }, { - "name": "index_prefixes", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "TextIndexPrefixes", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, - { - "name": "norms", + "name": "ignore_malformed", "required": false, "type": { "kind": "instance_of", @@ -91894,73 +95870,97 @@ } }, { - "name": "position_increment_gap", + "name": "ignore_z_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "search_analyzer", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "search_quote_analyzer", + "name": "orientation", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "GeoOrientation", + "namespace": "_types.mapping" } } }, { - "name": "term_vector", + "name": "strategy", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermVectorOption", + "name": "GeoStrategy", "namespace": "_types.mapping" } } }, { - "name": "format", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "geo_shape" + } + } + ], + "specLocation": "_types/mapping/geo.ts#L41-L55" + }, + { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "PointProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "ignore_malformed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "precision_step", + "name": "ignore_z_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "locale", + "name": "null_value", "required": false, "type": { "kind": "instance_of", @@ -91969,169 +95969,123 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "_types/mapping/core.ts#L318-L349" - }, - { - "kind": "enum", - "members": [ - { - "name": "gauge" - }, - { - "name": "counter" - }, - { - "name": "summary" - }, - { - "name": "histogram" }, { - "name": "position" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "point" + } } ], - "name": { - "name": "TimeSeriesMetricType", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/TimeSeriesMetricType.ts#L20-L26" + "specLocation": "_types/mapping/geo.ts#L67-L72" }, { + "description": "The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as\nrectangles and polygons.", + "docId": "shape", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/shape.html", + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, "kind": "interface", "name": { - "name": "TextIndexPrefixes", + "name": "ShapeProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "max_chars", - "required": true, + "name": "coerce", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "min_chars", - "required": true, + "name": "ignore_malformed", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/mapping/core.ts#L281-L284" - }, - { - "kind": "enum", - "members": [ - { - "name": "no" - }, - { - "name": "yes" - }, - { - "name": "with_offsets" }, { - "name": "with_positions" - }, - { - "name": "with_positions_offsets" + "name": "ignore_z_value", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "name": "with_positions_offsets_payloads" + "name": "orientation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "GeoOrientation", + "namespace": "_types.mapping" + } + } }, { - "name": "with_positions_payloads" + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "shape" + } } ], - "name": { - "name": "TermVectorOption", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/TermVectorOption.ts#L20-L28" + "specLocation": "_types/mapping/geo.ts#L74-L86" }, { "inherits": { "type": { - "name": "PropertyBase", + "name": "NumberPropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "JoinProperty", + "name": "ByteNumberProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "relations", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "RelationName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "RelationName", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "RelationName", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" - } - } - }, - { - "name": "eager_global_ordinals", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "byte" } }, { - "name": "type", - "required": true, + "name": "null_value", + "required": false, "type": { - "kind": "literal_value", - "value": "join" + "kind": "instance_of", + "type": { + "name": "byte", + "namespace": "_types" + } } } ], - "specLocation": "_types/mapping/core.ts#L92-L96" + "specLocation": "_types/mapping/core.ts#L176-L179" }, { "inherits": { @@ -92142,7 +96096,7 @@ }, "kind": "interface", "name": { - "name": "KeywordProperty", + "name": "NumberPropertyBase", "namespace": "_types.mapping" }, "properties": [ @@ -92158,7 +96112,18 @@ } }, { - "name": "eager_global_ordinals", + "name": "coerce", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "ignore_malformed", "required": false, "type": { "kind": "instance_of", @@ -92180,12 +96145,12 @@ } }, { - "name": "index_options", + "name": "on_script_error", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexOptions", + "name": "OnScriptError", "namespace": "_types.mapping" } } @@ -92202,37 +96167,104 @@ } }, { - "name": "on_script_error", + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "stability": "experimental" + } + }, + "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "name": "time_series_metric", "required": false, "type": { "kind": "instance_of", "type": { - "name": "OnScriptError", + "name": "TimeSeriesMetricType", "namespace": "_types.mapping" } } }, { - "name": "normalizer", + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "stability": "experimental" + } + }, + "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "name": "time_series_dimension", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } + } + ], + "specLocation": "_types/mapping/core.ts#L119-L139" + }, + { + "inherits": { + "type": { + "name": "NumberPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "DoubleNumberProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "double" + } }, { - "name": "norms", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } + } + ], + "specLocation": "_types/mapping/core.ts#L156-L159" + }, + { + "inherits": { + "type": { + "name": "NumberPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "FloatNumberProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "float" + } }, { "name": "null_value", @@ -92240,81 +96272,129 @@ "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "float", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/mapping/core.ts#L146-L149" + }, + { + "inherits": { + "type": { + "name": "NumberPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "HalfFloatNumberProperty", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "similarity", - "required": false, + "name": "type", + "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "literal_value", + "value": "half_float" } }, { - "name": "split_queries_on_whitespace", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "float", + "namespace": "_types" } } + } + ], + "specLocation": "_types/mapping/core.ts#L151-L154" + }, + { + "inherits": { + "type": { + "name": "NumberPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "IntegerNumberProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "integer" + } }, { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "stability": "experimental" - } - }, - "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", - "name": "time_series_dimension", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/mapping/core.ts#L161-L164" + }, + { + "inherits": { + "type": { + "name": "NumberPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "LongNumberProperty", + "namespace": "_types.mapping" + }, + "properties": [ { "name": "type", "required": true, "type": { "kind": "literal_value", - "value": "keyword" + "value": "long" + } + }, + { + "name": "null_value", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } } ], - "specLocation": "_types/mapping/core.ts#L98-L117" + "specLocation": "_types/mapping/core.ts#L166-L169" }, { - "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.", + "inherits": { + "type": { + "name": "NumberPropertyBase", + "namespace": "_types.mapping" + } + }, "kind": "interface", "name": { - "name": "MatchOnlyTextProperty", + "name": "ScaledFloatNumberProperty", "namespace": "_types.mapping" }, "properties": [ @@ -92323,84 +96403,79 @@ "required": true, "type": { "kind": "literal_value", - "value": "match_only_text" + "value": "scaled_float" } }, { - "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.", - "docId": "multi-fields", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-fields.html", - "name": "fields", + "name": "null_value", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "PropertyName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Property", - "namespace": "_types.mapping" - } + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } }, { - "description": "Metadata about the field.", - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "meta", + "name": "scaling_factor", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } + } + ], + "specLocation": "_types/mapping/core.ts#L186-L190" + }, + { + "inherits": { + "type": { + "name": "NumberPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "ShortNumberProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "short" + } }, { - "description": "Allows you to copy the values of multiple fields into a group\nfield, which can then be queried as a single field.", - "name": "copy_to", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", + "name": "short", "namespace": "_types" } } } ], - "specLocation": "_types/mapping/core.ts#L247-L272" + "specLocation": "_types/mapping/core.ts#L171-L174" }, { "inherits": { "type": { - "name": "PropertyBase", + "name": "NumberPropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "PercolatorProperty", + "name": "UnsignedLongNumberProperty", "namespace": "_types.mapping" }, "properties": [ @@ -92409,32 +96484,43 @@ "required": true, "type": { "kind": "literal_value", - "value": "percolator" + "value": "unsigned_long" + } + }, + { + "name": "null_value", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ulong", + "namespace": "_types" + } } } ], - "specLocation": "_types/mapping/core.ts#L192-L194" + "specLocation": "_types/mapping/core.ts#L181-L184" }, { "inherits": { "type": { - "name": "PropertyBase", + "name": "RangePropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "RankFeatureProperty", + "name": "DateRangeProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "positive_score_impact", + "name": "format", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } @@ -92444,27 +96530,38 @@ "required": true, "type": { "kind": "literal_value", - "value": "rank_feature" + "value": "date_range" } } ], - "specLocation": "_types/mapping/core.ts#L196-L199" + "specLocation": "_types/mapping/range.ts#L29-L32" }, { "inherits": { "type": { - "name": "PropertyBase", + "name": "DocValuesPropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "RankFeaturesProperty", + "name": "RangePropertyBase", "namespace": "_types.mapping" }, "properties": [ { - "name": "positive_score_impact", + "name": "boost", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + }, + { + "name": "coerce", "required": false, "type": { "kind": "instance_of", @@ -92474,43 +96571,163 @@ } } }, + { + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/mapping/range.ts#L23-L27" + }, + { + "inherits": { + "type": { + "name": "RangePropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "DoubleRangeProperty", + "namespace": "_types.mapping" + }, + "properties": [ { "name": "type", "required": true, "type": { "kind": "literal_value", - "value": "rank_features" + "value": "double_range" } } ], - "specLocation": "_types/mapping/core.ts#L201-L204" + "specLocation": "_types/mapping/range.ts#L34-L36" }, { "inherits": { "type": { - "name": "CorePropertyBase", + "name": "RangePropertyBase", "namespace": "_types.mapping" } }, "kind": "interface", "name": { - "name": "SearchAsYouTypeProperty", + "name": "FloatRangeProperty", "namespace": "_types.mapping" }, "properties": [ { - "name": "analyzer", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "float_range" + } + } + ], + "specLocation": "_types/mapping/range.ts#L38-L40" + }, + { + "inherits": { + "type": { + "name": "RangePropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "IntegerRangeProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "integer_range" + } + } + ], + "specLocation": "_types/mapping/range.ts#L42-L44" + }, + { + "inherits": { + "type": { + "name": "RangePropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "IpRangeProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "ip_range" + } + } + ], + "specLocation": "_types/mapping/range.ts#L46-L48" + }, + { + "inherits": { + "type": { + "name": "RangePropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "LongRangeProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "long_range" + } + } + ], + "specLocation": "_types/mapping/range.ts#L50-L52" + }, + { + "inherits": { + "type": { + "name": "DocValuesPropertyBase", + "namespace": "_types.mapping" + } + }, + "kind": "interface", + "name": { + "name": "IcuCollationProperty", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "icu_collation_keyword" } }, { - "name": "index", + "name": "norms", "required": false, "type": { "kind": "instance_of", @@ -92532,29 +96749,31 @@ } }, { - "name": "max_shingle_size", + "description": "Should the field be searchable?", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "norms", + "description": "Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing.", + "name": "null_value", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "search_analyzer", + "name": "rules", "required": false, "type": { "kind": "instance_of", @@ -92565,7 +96784,7 @@ } }, { - "name": "search_quote_analyzer", + "name": "language", "required": false, "type": { "kind": "instance_of", @@ -92576,98 +96795,62 @@ } }, { - "name": "similarity", + "name": "country", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "term_vector", + "name": "variant", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TermVectorOption", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "search_as_you_type" - } - } - ], - "specLocation": "_types/mapping/core.ts#L228-L239" - }, - { - "inherits": { - "type": { - "name": "CorePropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "TextProperty", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "analyzer", + "name": "strength", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IcuCollationStrength", + "namespace": "_types.analysis" } } }, { - "name": "boost", + "name": "decomposition", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "IcuCollationDecomposition", + "namespace": "_types.analysis" } } }, { - "name": "eager_global_ordinals", + "name": "alternate", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IcuCollationAlternate", + "namespace": "_types.analysis" } } }, { - "name": "fielddata", + "name": "case_level", "required": false, "type": { "kind": "instance_of", @@ -92678,18 +96861,18 @@ } }, { - "name": "fielddata_frequency_filter", + "name": "case_first", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FielddataFrequencyFilter", - "namespace": "indices._types" + "name": "IcuCollationCaseFirst", + "namespace": "_types.analysis" } } }, { - "name": "index", + "name": "numeric", "required": false, "type": { "kind": "instance_of", @@ -92700,18 +96883,18 @@ } }, { - "name": "index_options", + "name": "variable_top", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexOptions", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "index_phrases", + "name": "hiragana_quaternary_mode", "required": false, "type": { "kind": "instance_of", @@ -92720,1786 +96903,1490 @@ "namespace": "_builtins" } } + } + ], + "specLocation": "_types/mapping/specialized.ts#L103-L127" + }, + { + "kind": "enum", + "members": [ + { + "name": "disabled" }, { - "name": "index_prefixes", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "TextIndexPrefixes", - "namespace": "_types.mapping" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } + "name": "stored" }, { - "name": "norms", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "description": "Instead of storing source documents on disk exactly as you send them,\n Elasticsearch can reconstruct source content on the fly upon retrieval.", + "name": "synthetic" + } + ], + "name": { + "name": "SourceFieldMode", + "namespace": "_types.mapping" + }, + "specLocation": "_types/mapping/meta-fields.ts#L67-L75" + }, + { + "kind": "enum", + "members": [ + { + "description": "Disables all operators.", + "name": "NONE" }, { - "name": "position_increment_gap", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "description": "Enables the `+` AND operator.", + "name": "AND" }, { - "name": "search_analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "description": "Enables the `-` NOT operator.", + "name": "NOT" }, { - "name": "search_quote_analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "description": "Enables the `\\|` OR operator.", + "name": "OR" }, { - "name": "similarity", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } + "description": "Enables the `*` prefix operator.", + "name": "PREFIX" + }, + { + "description": "Enables the `\"` quotes operator used to search for phrases.", + "name": "PHRASE" + }, + { + "description": "Enables the `(` and `)` operators to control operator precedence.", + "name": "PRECEDENCE" + }, + { + "description": "Enables `\\` as an escape character.", + "name": "ESCAPE" + }, + { + "description": "Enables whitespace as split characters.", + "name": "WHITESPACE" + }, + { + "description": "Enables the `~N` operator after a word, where `N` is an integer denoting the allowed edit distance for matching.", + "name": "FUZZY" + }, + { + "description": "Enables the `~N` operator, after a phrase where `N` is the maximum number of positions allowed between matching tokens.\nSynonymous to `SLOP`.", + "name": "NEAR" + }, + { + "description": "Enables the `~N` operator, after a phrase where `N` is maximum number of positions allowed between matching tokens.\nSynonymous to `NEAR`.", + "name": "SLOP" + }, + { + "description": "Enables all optional operators.", + "name": "ALL" + } + ], + "name": { + "name": "SimpleQueryStringFlag", + "namespace": "_types.query_dsl" + }, + "specLocation": "_types/query_dsl/fulltext.ts#L729-L784" + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "ae" + ], + "description": "For open anomaly detection jobs only, contains messages relating to the\nselection of a node to run the job.", + "name": "assignment_explanation" + }, + { + "aliases": [ + "bc", + "bucketsCount" + ], + "description": "The number of bucket results produced by the job.", + "name": "buckets.count" + }, + { + "aliases": [ + "btea", + "bucketsTimeExpAvg" + ], + "description": "Exponential moving average of all bucket processing times, in milliseconds.", + "name": "buckets.time.exp_avg" + }, + { + "aliases": [ + "bteah", + "bucketsTimeExpAvgHour" + ], + "description": "Exponentially-weighted moving average of bucket processing times calculated\nin a 1 hour time window, in milliseconds.", + "name": "buckets.time.exp_avg_hour" + }, + { + "aliases": [ + "btmax", + "bucketsTimeMax" + ], + "description": "Maximum among all bucket processing times, in milliseconds.", + "name": "buckets.time.max" + }, + { + "aliases": [ + "btmin", + "bucketsTimeMin" + ], + "description": "Minimum among all bucket processing times, in milliseconds.", + "name": "buckets.time.min" + }, + { + "aliases": [ + "btt", + "bucketsTimeTotal" + ], + "description": "Sum of all bucket processing times, in milliseconds.", + "name": "buckets.time.total" + }, + { + "aliases": [ + "db", + "dataBuckets" + ], + "description": "The number of buckets processed.", + "name": "data.buckets" + }, + { + "aliases": [ + "der", + "dataEarliestRecord" + ], + "description": "The timestamp of the earliest chronologically input document.", + "name": "data.earliest_record" + }, + { + "aliases": [ + "deb", + "dataEmptyBuckets" + ], + "description": "The number of buckets which did not contain any data.", + "name": "data.empty_buckets" + }, + { + "aliases": [ + "dib", + "dataInputBytes" + ], + "description": "The number of bytes of input data posted to the anomaly detection job.", + "name": "data.input_bytes" + }, + { + "aliases": [ + "dif", + "dataInputFields" + ], + "description": "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.", + "name": "data.input_fields" + }, + { + "aliases": [ + "dir", + "dataInputRecords" + ], + "description": "The number of input documents posted to the anomaly detection job.", + "name": "data.input_records" + }, + { + "aliases": [ + "did", + "dataInvalidDates" + ], + "description": "The number of input documents with either a missing date field or a date\nthat could not be parsed.", + "name": "data.invalid_dates" + }, + { + "aliases": [ + "dl", + "dataLast" + ], + "description": "The timestamp at which data was last analyzed, according to server time.", + "name": "data.last" + }, + { + "aliases": [ + "dleb", + "dataLastEmptyBucket" + ], + "description": "The timestamp of the last bucket that did not contain any data.", + "name": "data.last_empty_bucket" + }, + { + "aliases": [ + "dlsb", + "dataLastSparseBucket" + ], + "description": "The timestamp of the last bucket that was considered sparse.", + "name": "data.last_sparse_bucket" + }, + { + "aliases": [ + "dlr", + "dataLatestRecord" + ], + "description": "The timestamp of the latest chronologically input document.", + "name": "data.latest_record" + }, + { + "aliases": [ + "dmf", + "dataMissingFields" + ], + "description": "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.", + "name": "data.missing_fields" + }, + { + "aliases": [ + "doot", + "dataOutOfOrderTimestamps" + ], + "description": "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.", + "name": "data.out_of_order_timestamps" + }, + { + "aliases": [ + "dpf", + "dataProcessedFields" + ], + "description": "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.", + "name": "data.processed_fields" + }, + { + "aliases": [ + "dpr", + "dataProcessedRecords" + ], + "description": "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.", + "name": "data.processed_records" + }, + { + "aliases": [ + "dsb", + "dataSparseBuckets" + ], + "description": "The number of buckets that contained few data points compared to the\nexpected number of data points.", + "name": "data.sparse_buckets" + }, + { + "aliases": [ + "fmavg", + "forecastsMemoryAvg" + ], + "description": "The average memory usage in bytes for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.memory.avg" + }, + { + "aliases": [ + "fmmax", + "forecastsMemoryMax" + ], + "description": "The maximum memory usage in bytes for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.memory.max" + }, + { + "aliases": [ + "fmmin", + "forecastsMemoryMin" + ], + "description": "The minimum memory usage in bytes for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.memory.min" + }, + { + "aliases": [ + "fmt", + "forecastsMemoryTotal" + ], + "description": "The total memory usage in bytes for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.memory.total" + }, + { + "aliases": [ + "fravg", + "forecastsRecordsAvg" + ], + "description": "The average number of `m`odel_forecast` documents written for forecasts\nrelated to the anomaly detection job.", + "name": "forecasts.records.avg" + }, + { + "aliases": [ + "frmax", + "forecastsRecordsMax" + ], + "description": "The maximum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", + "name": "forecasts.records.max" + }, + { + "aliases": [ + "frmin", + "forecastsRecordsMin" + ], + "description": "The minimum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", + "name": "forecasts.records.min" + }, + { + "aliases": [ + "frt", + "forecastsRecordsTotal" + ], + "description": "The total number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", + "name": "forecasts.records.total" }, { - "name": "term_vector", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TermVectorOption", - "namespace": "_types.mapping" - } - } + "aliases": [ + "ftavg", + "forecastsTimeAvg" + ], + "description": "The average runtime in milliseconds for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.time.avg" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "text" - } - } - ], - "specLocation": "_types/mapping/core.ts#L286-L303" - }, - { - "kind": "interface", - "name": { - "name": "FielddataFrequencyFilter", - "namespace": "indices._types" - }, - "properties": [ + "aliases": [ + "ftmax", + "forecastsTimeMax" + ], + "description": "The maximum runtime in milliseconds for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.time.max" + }, { - "name": "max", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "aliases": [ + "ftmin", + "forecastsTimeMin" + ], + "description": "The minimum runtime in milliseconds for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.time.min" }, { - "name": "min", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "aliases": [ + "ftt", + "forecastsTimeTotal" + ], + "description": "The total runtime in milliseconds for forecasts related to the anomaly\ndetection job.", + "name": "forecasts.time.total" }, { - "name": "min_segment_size", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/_types/FielddataFrequencyFilter.ts#L22-L26" - }, - { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "VersionProperty", - "namespace": "_types.mapping" - }, - "properties": [ + "aliases": [ + "ft", + "forecastsTotal" + ], + "description": "The number of individual forecasts currently available for the job.", + "name": "forecasts.total" + }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "version" - } - } - ], - "specLocation": "_types/mapping/core.ts#L305-L307" - }, - { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "WildcardProperty", - "namespace": "_types.mapping" - }, - "properties": [ + "description": "Identifier for the anomaly detection job.", + "name": "id" + }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "wildcard" - } + "aliases": [ + "mbaf", + "modelBucketAllocationFailures" + ], + "description": "The number of buckets for which new entities in incoming data were not\nprocessed due to insufficient model memory.", + "name": "model.bucket_allocation_failures" }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.15.0" - } - }, - "name": "null_value", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "_types/mapping/core.ts#L309-L316" - }, - { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "DateNanosProperty", - "namespace": "_types.mapping" - }, - "properties": [ + "aliases": [ + "mbf", + "modelByFields" + ], + "description": "The number of by field values that were analyzed by the models. This value\nis cumulative for all detectors in the job.", + "name": "model.by_fields" + }, { - "name": "boost", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "aliases": [ + "mb", + "modelBytes" + ], + "description": "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.", + "name": "model.bytes" }, { - "name": "format", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "aliases": [ + "mbe", + "modelBytesExceeded" + ], + "description": "The number of bytes over the high limit for memory usage at the last\nallocation failure.", + "name": "model.bytes_exceeded" }, { - "name": "ignore_malformed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "mcs", + "modelCategorizationStatus" + ], + "description": "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.", + "name": "model.categorization_status" }, { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "mcdc", + "modelCategorizedDocCount" + ], + "description": "The number of documents that have had a field categorized.", + "name": "model.categorized_doc_count" }, { - "name": "script", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" - } - } + "aliases": [ + "mdcc", + "modelDeadCategoryCount" + ], + "description": "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.", + "name": "model.dead_category_count" }, { - "name": "on_script_error", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "OnScriptError", - "namespace": "_types.mapping" - } - } + "aliases": [ + "mdcc", + "modelFailedCategoryCount" + ], + "description": "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.", + "name": "model.failed_category_count" }, { - "name": "null_value", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } + "aliases": [ + "mfcc", + "modelFrequentCategoryCount" + ], + "description": "The number of categories that match more than 1% of categorized documents.", + "name": "model.frequent_category_count" }, { - "name": "precision_step", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "aliases": [ + "mlt", + "modelLogTime" + ], + "description": "The timestamp when the model stats were gathered, according to server time.", + "name": "model.log_time" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "date_nanos" - } - } - ], - "specLocation": "_types/mapping/core.ts#L80-L90" - }, - { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "DateProperty", - "namespace": "_types.mapping" - }, - "properties": [ + "aliases": [ + "mml", + "modelMemoryLimit" + ], + "description": "The timestamp when the model stats were gathered, according to server time.", + "name": "model.memory_limit" + }, { - "name": "boost", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "aliases": [ + "mms", + "modelMemoryStatus" + ], + "description": "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.", + "name": "model.memory_status" }, { - "name": "fielddata", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "NumericFielddata", - "namespace": "indices._types" - } - } + "aliases": [ + "mof", + "modelOverFields" + ], + "description": "The number of over field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.", + "name": "model.over_fields" }, { - "name": "format", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "aliases": [ + "mpf", + "modelPartitionFields" + ], + "description": "The number of partition field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.", + "name": "model.partition_fields" }, { - "name": "ignore_malformed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "mrcc", + "modelRareCategoryCount" + ], + "description": "The number of categories that match just one categorized document.", + "name": "model.rare_category_count" }, { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "mt", + "modelTimestamp" + ], + "description": "The timestamp of the last record when the model stats were gathered.", + "name": "model.timestamp" }, { - "name": "script", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" - } - } + "aliases": [ + "mtcc", + "modelTotalCategoryCount" + ], + "description": "The number of categories created by categorization.", + "name": "model.total_category_count" }, { - "name": "on_script_error", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "OnScriptError", - "namespace": "_types.mapping" - } - } + "aliases": [ + "na", + "nodeAddress" + ], + "description": "The network address of the node that runs the job. This information is\navailable only for open jobs.", + "name": "node.address" }, { - "name": "null_value", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } + "aliases": [ + "ne", + "nodeEphemeralId" + ], + "description": "The ephemeral ID of the node that runs the job. This information is\navailable only for open jobs.", + "name": "node.ephemeral_id" }, { - "name": "precision_step", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "aliases": [ + "ni", + "nodeId" + ], + "description": "The unique identifier of the node that runs the job. This information is\navailable only for open jobs.", + "name": "node.id" }, { - "name": "locale", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "aliases": [ + "nn", + "nodeName" + ], + "description": "The name of the node that runs the job. This information is available only\nfor open jobs.", + "name": "node.name" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "date" - } + "aliases": [ + "ot" + ], + "description": "For open jobs only, the elapsed time for which the job has been open.", + "name": "opened_time" + }, + { + "aliases": [ + "s" + ], + "description": "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.", + "name": "state" } ], - "specLocation": "_types/mapping/core.ts#L66-L78" + "name": { + "name": "CatAnomalyDetectorColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L32-L401" }, { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", + "kind": "type_alias", "name": { - "name": "AggregateMetricDoubleProperty", - "namespace": "_types.mapping" + "name": "CatAnonalyDetectorColumns", + "namespace": "cat._types" }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "aggregate_metric_double" - } - }, - { - "name": "default_metric", - "required": true, - "type": { + "specLocation": "cat/_types/CatBase.ts#L402-L404", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CatAnomalyDetectorColumn", + "namespace": "cat._types" } - } - }, - { - "name": "metrics", - "required": true, - "type": { + }, + { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CatAnomalyDetectorColumn", + "namespace": "cat._types" } } } - }, - { - "name": "time_series_metric", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeSeriesMetricType", - "namespace": "_types.mapping" - } - } - } - ], - "specLocation": "_types/mapping/complex.ts#L59-L64" + ], + "kind": "union_of" + } }, { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "DenseVectorProperty", - "namespace": "_types.mapping" - }, - "properties": [ + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "dense_vector" - } + "aliases": [ + "assignment_explanation" + ], + "description": "For started datafeeds only, contains messages relating to the selection of\na node.", + "name": "ae" }, { - "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.", - "name": "dims", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "aliases": [ + "buckets.count", + "bucketsCount" + ], + "description": "The number of buckets processed.", + "name": "bc" }, { - "description": "The data type used to encode vectors. The supported data types are `float` (default), `byte`, and `bit`.", - "name": "element_type", - "required": false, - "serverDefault": "float", - "type": { - "kind": "instance_of", - "type": { - "name": "DenseVectorElementType", - "namespace": "_types.mapping" - } - } + "description": "A numerical character string that uniquely identifies the datafeed.", + "name": "id" }, { - "description": "If `true`, you can search this field using the kNN search API.", - "name": "index", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "node.address", + "nodeAddress" + ], + "description": "For started datafeeds only, the network address of the node where the\ndatafeed is started.", + "name": "na" }, { - "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`.", - "name": "index_options", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DenseVectorIndexOptions", - "namespace": "_types.mapping" - } - } + "aliases": [ + "node.ephemeral_id", + "nodeEphemeralId" + ], + "description": "For started datafeeds only, the ephemeral ID of the node where the\ndatafeed is started.", + "name": "ne" }, { - "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`.", - "name": "similarity", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DenseVectorSimilarity", - "namespace": "_types.mapping" - } - } - } - ], - "specLocation": "_types/mapping/DenseVectorProperty.ts#L23-L62" - }, - { - "kind": "interface", - "name": { - "name": "DenseVectorIndexOptions", - "namespace": "_types.mapping" - }, - "properties": [ + "aliases": [ + "node.id", + "nodeId" + ], + "description": "For started datafeeds only, the unique identifier of the node where the\ndatafeed is started.", + "name": "ni" + }, { - "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.", - "name": "confidence_interval", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } + "aliases": [ + "node.name", + "nodeName" + ], + "description": "For started datafeeds only, the name of the node where the datafeed is\nstarted.", + "name": "nn" }, { - "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`, and `int4_hnsw` index types.", - "name": "ef_construction", - "required": false, - "serverDefault": 100, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "aliases": [ + "search.bucket_avg", + "searchBucketAvg" + ], + "description": "The average search time per bucket, in milliseconds.", + "name": "sba" }, { - "description": "The number of neighbors each node will be connected to in the HNSW graph.\n\nOnly applicable to `hnsw`, `int8_hnsw`, and `int4_hnsw` index types.", - "name": "m", - "required": false, - "serverDefault": 16, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "aliases": [ + "search.count", + "searchCount" + ], + "description": "The number of searches run by the datafeed.", + "name": "sc" }, { - "description": "The type of kNN algorithm to use.", - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DenseVectorIndexOptionsType", - "namespace": "_types.mapping" - } - } + "aliases": [ + "search.exp_avg_hour", + "searchExpAvgHour" + ], + "description": "The exponential average search time per hour, in milliseconds.", + "name": "seah" + }, + { + "aliases": [ + "search.time", + "searchTime" + ], + "description": "The total time the datafeed spent searching, in milliseconds.", + "name": "st" + }, + { + "aliases": [ + "state" + ], + "description": "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.", + "name": "s" } ], - "specLocation": "_types/mapping/DenseVectorProperty.ts#L129-L162" + "name": { + "name": "CatDatafeedColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L405-L471" }, { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", + "kind": "type_alias", "name": { - "name": "FlattenedProperty", - "namespace": "_types.mapping" + "name": "CatDatafeedColumns", + "namespace": "cat._types" }, - "properties": [ - { - "name": "boost", - "required": false, - "type": { + "specLocation": "cat/_types/CatBase.ts#L559-L559", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "CatDatafeedColumn", + "namespace": "cat._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatDatafeedColumn", + "namespace": "cat._types" + } } } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "ae" + ], + "description": "Contains messages relating to the selection of a node.", + "name": "assignment_explanation" }, { - "name": "depth_limit", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "aliases": [ + "ct", + "createTime" + ], + "description": "The time when the data frame analytics job was created.", + "name": "create_time" }, { - "name": "doc_values", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "d" + ], + "description": "A description of a job.", + "name": "description" }, { - "name": "eager_global_ordinals", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "di", + "destIndex" + ], + "description": "Name of the destination index.", + "name": "dest_index" }, { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "fr", + "failureReason" + ], + "description": "Contains messages about the reason why a data frame analytics job failed.", + "name": "failure_reason" }, { - "name": "index_options", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexOptions", - "namespace": "_types.mapping" - } - } + "description": "Identifier for the data frame analytics job.", + "name": "id" }, { - "name": "null_value", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "aliases": [ + "mml", + "modelMemoryLimit" + ], + "description": "The approximate maximum amount of memory resources that are permitted for\nthe data frame analytics job.", + "name": "model_memory_limit" }, { - "name": "similarity", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "aliases": [ + "na", + "nodeAddress" + ], + "description": "The network address of the node that the data frame analytics job is\nassigned to.", + "name": "node.address" }, { - "name": "split_queries_on_whitespace", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "ne", + "nodeEphemeralId" + ], + "description": "The ephemeral ID of the node that the data frame analytics job is assigned\nto.", + "name": "node.ephemeral_id" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "flattened" - } - } - ], - "specLocation": "_types/mapping/complex.ts#L26-L37" - }, - { - "inherits": { - "type": { - "name": "CorePropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "NestedProperty", - "namespace": "_types.mapping" - }, - "properties": [ + "aliases": [ + "ni", + "nodeId" + ], + "description": "The unique identifier of the node that the data frame analytics job is\nassigned to.", + "name": "node.id" + }, { - "name": "enabled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "nn", + "nodeName" + ], + "description": "The name of the node that the data frame analytics job is assigned to.", + "name": "node.name" }, { - "name": "include_in_parent", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "p" + ], + "description": "The progress report of the data frame analytics job by phase.", + "name": "progress" }, { - "name": "include_in_root", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "si", + "sourceIndex" + ], + "description": "Name of the source index.", + "name": "source_index" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "nested" - } + "aliases": [ + "s" + ], + "description": "Current state of the data frame analytics job.", + "name": "state" + }, + { + "aliases": [ + "t" + ], + "description": "The type of analysis that the data frame analytics job performs.", + "name": "type" + }, + { + "aliases": [ + "v" + ], + "description": "The Elasticsearch version number in which the data frame analytics job was\ncreated.", + "name": "version" } ], - "specLocation": "_types/mapping/complex.ts#L39-L44" + "name": { + "name": "CatDfaColumn", + "namespace": "cat._types" + }, + "specLocation": "cat/_types/CatBase.ts#L472-L557" }, { - "inherits": { - "type": { - "name": "CorePropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", + "kind": "type_alias", "name": { - "name": "ObjectProperty", - "namespace": "_types.mapping" + "name": "CatDfaColumns", + "namespace": "cat._types" }, - "properties": [ - { - "name": "enabled", - "required": false, - "type": { + "specLocation": "cat/_types/CatBase.ts#L558-L558", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "CatDfaColumn", + "namespace": "cat._types" } - } - }, - { - "name": "subobjects", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Subobjects", - "namespace": "_types.mapping" + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatDfaColumn", + "namespace": "cat._types" + } } } - }, - { - "name": "type", - "required": false, - "type": { - "kind": "literal_value", - "value": "object" - } - } - ], - "specLocation": "_types/mapping/complex.ts#L46-L50" + ], + "kind": "union_of" + } }, { - "esQuirk": "This enum is a boolean that evolved into a tri-state enum. True and False have\nto be (de)serialized as JSON booleans.", "kind": "enum", "members": [ { - "name": "true" + "aliases": [ + "ct" + ], + "description": "The time when the trained model was created.", + "name": "create_time" }, { - "name": "false" - } - ], - "name": { - "name": "Subobjects", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/TypeMapping.ts#L63-L74" - }, - { - "inherits": { - "type": { - "name": "CorePropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "PassthroughObjectProperty", - "namespace": "_types.mapping" - }, - "properties": [ + "aliases": [ + "c", + "createdBy" + ], + "description": "Information on the creator of the trained model.", + "name": "created_by" + }, { - "name": "type", - "required": false, - "type": { - "kind": "literal_value", - "value": "passthrough" - } + "aliases": [ + "df", + "dataFrameAnalytics", + "dfid" + ], + "description": "Identifier for the data frame analytics job that created the model. Only\ndisplayed if it is still available.", + "name": "data_frame_analytics_id" }, { - "name": "enabled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "d" + ], + "description": "The description of the trained model.", + "name": "description" }, { - "name": "priority", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "aliases": [ + "hs", + "modelHeapSize" + ], + "description": "The estimated heap size to keep the trained model in memory.", + "name": "heap_size" }, { - "name": "time_series_dimension", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "_types/mapping/complex.ts#L52-L57" - }, - { - "kind": "interface", - "name": { - "name": "SemanticTextProperty", - "namespace": "_types.mapping" - }, - "properties": [ + "description": "Identifier for the trained model.", + "name": "id" + }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "semantic_text" - } + "aliases": [ + "ic", + "ingestCount" + ], + "description": "The total number of documents that are processed by the model.", + "name": "ingest.count" }, { - "name": "meta", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } + "aliases": [ + "icurr", + "ingestCurrent" + ], + "description": "The total number of document that are currently being handled by the\ntrained model.", + "name": "ingest.current" }, { - "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.", - "name": "inference_id", - "required": false, - "serverDefault": ".elser-2-elasticsearch", - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } + "aliases": [ + "if", + "ingestFailed" + ], + "description": "The total number of failed ingest attempts with the trained model.", + "name": "ingest.failed" }, { - "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.", - "name": "search_inference_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } + "aliases": [ + "ip", + "ingestPipelines" + ], + "description": "The total number of ingest pipelines that are referencing the trained\nmodel.", + "name": "ingest.pipelines" + }, + { + "aliases": [ + "it", + "ingestTime" + ], + "description": "The total time that is spent processing documents with the trained model.", + "name": "ingest.time" + }, + { + "aliases": [ + "l" + ], + "description": "The license level of the trained model.", + "name": "license" + }, + { + "aliases": [ + "o", + "modelOperations" + ], + "description": "The estimated number of operations to use the trained model. This number\nhelps measuring the computational complexity of the model.", + "name": "operations" + }, + { + "aliases": [ + "v" + ], + "description": "The Elasticsearch version number in which the trained model was created.", + "name": "version" } ], - "specLocation": "_types/mapping/core.ts#L210-L226" - }, - { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", "name": { - "name": "SparseVectorProperty", - "namespace": "_types.mapping" + "name": "CatTrainedModelsColumn", + "namespace": "cat._types" }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "sparse_vector" - } - } - ], - "specLocation": "_types/mapping/core.ts#L206-L208" + "specLocation": "cat/_types/CatBase.ts#L561-L635" }, { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", + "kind": "type_alias", "name": { - "name": "CompletionProperty", - "namespace": "_types.mapping" + "name": "CatTrainedModelsColumns", + "namespace": "cat._types" }, - "properties": [ - { - "name": "analyzer", - "required": false, - "type": { + "specLocation": "cat/_types/CatBase.ts#L636-L638", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CatTrainedModelsColumn", + "namespace": "cat._types" } - } - }, - { - "name": "contexts", - "required": false, - "type": { + }, + { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "SuggestContext", - "namespace": "_types.mapping" + "name": "CatTrainedModelsColumn", + "namespace": "cat._types" } } } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "aliases": [ + "cldt" + ], + "description": "The timestamp when changes were last detected in the source indices.", + "name": "changes_last_detection_time" }, { - "name": "max_input_length", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "aliases": [ + "cp" + ], + "description": "The sequence number for the checkpoint.", + "name": "checkpoint" }, { - "name": "preserve_position_increments", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "cdtea", + "checkpointTimeExpAvg" + ], + "description": "Exponential moving average of the duration of the checkpoint, in\nmilliseconds.", + "name": "checkpoint_duration_time_exp_avg" }, { - "name": "preserve_separators", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "c", + "checkpointProgress" + ], + "description": "The progress of the next checkpoint that is currently in progress.", + "name": "checkpoint_progress" }, { - "name": "search_analyzer", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "aliases": [ + "ct", + "createTime" + ], + "description": "The time the transform was created.", + "name": "create_time" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "completion" - } - } - ], - "specLocation": "_types/mapping/specialized.ts#L33-L41" - }, - { - "kind": "interface", - "name": { - "name": "SuggestContext", - "namespace": "_types.mapping" - }, - "properties": [ + "aliases": [ + "dtime" + ], + "description": "The amount of time spent deleting, in milliseconds.", + "name": "delete_time" + }, { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } + "aliases": [ + "d" + ], + "description": "The description of the transform.", + "name": "description" }, { - "name": "path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } + "aliases": [ + "di", + "destIndex" + ], + "description": "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.", + "name": "dest_index" + }, + { + "aliases": [ + "docd" + ], + "description": "The number of documents that have been deleted from the destination index\ndue to the retention policy for this transform.", + "name": "documents_deleted" + }, + { + "aliases": [ + "doci" + ], + "description": "The number of documents that have been indexed into the destination index\nfor the transform.", + "name": "documents_indexed" + }, + { + "aliases": [ + "dps" + ], + "description": "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.", + "name": "docs_per_second" + }, + { + "aliases": [ + "docp" + ], + "description": "The number of documents that have been processed from the source index of\nthe transform.", + "name": "documents_processed" + }, + { + "aliases": [ + "f" + ], + "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`. The default\nvalue is `1m`.", + "name": "frequency" + }, + { + "description": "Identifier for the transform.", + "name": "id" + }, + { + "aliases": [ + "if" + ], + "description": "The number of indexing failures.", + "name": "index_failure" + }, + { + "aliases": [ + "itime" + ], + "description": "The amount of time spent indexing, in milliseconds.", + "name": "index_time" }, { - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "aliases": [ + "it" + ], + "description": "The number of index operations.", + "name": "index_total" }, { - "name": "precision", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - } - ], - "specLocation": "_types/mapping/specialized.ts#L43-L48" - }, - { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "ConstantKeywordProperty", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "value", - "required": false, - "type": { - "kind": "user_defined_value" - } + "aliases": [ + "idea" + ], + "description": "Exponential moving average of the number of new documents that have been\nindexed.", + "name": "indexed_documents_exp_avg" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "constant_keyword" - } - } - ], - "specLocation": "_types/mapping/specialized.ts#L50-L53" - }, - { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "CountedKeywordProperty", - "namespace": "_types.mapping" - }, - "properties": [ + "aliases": [ + "lst", + "lastSearchTime" + ], + "description": "The timestamp of the last search in the source indices. This field is only\nshown if the transform is running.", + "name": "last_search_time" + }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "counted_keyword" - } + "aliases": [ + "mpsz" + ], + "description": "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`.", + "name": "max_page_search_size" }, { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "_types/mapping/specialized.ts#L55-L62" - }, - { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "FieldAliasProperty", - "namespace": "_types.mapping" - }, - "properties": [ + "aliases": [ + "pp" + ], + "description": "The number of search or bulk index operations processed. Documents are\nprocessed in batches instead of individually.", + "name": "pages_processed" + }, { - "name": "path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } + "aliases": [ + "p" + ], + "description": "The unique identifier for an ingest pipeline.", + "name": "pipeline" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "alias" - } - } - ], - "specLocation": "_types/mapping/specialized.ts#L64-L67" - }, - { - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "HistogramProperty", - "namespace": "_types.mapping" - }, - "properties": [ + "aliases": [ + "pdea" + ], + "description": "Exponential moving average of the number of documents that have been\nprocessed.", + "name": "processed_documents_exp_avg" + }, { - "name": "ignore_malformed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "pt" + ], + "description": "The amount of time spent processing results, in milliseconds.", + "name": "processing_time" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "histogram" - } - } - ], - "specLocation": "_types/mapping/specialized.ts#L69-L72" - }, - { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "IpProperty", - "namespace": "_types.mapping" - }, - "properties": [ + "aliases": [ + "r" + ], + "description": "If a transform has a `failed` state, this property provides details about\nthe reason for the failure.", + "name": "reason" + }, { - "name": "boost", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "aliases": [ + "sf" + ], + "description": "The number of search failures.", + "name": "search_failure" }, { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "stime" + ], + "description": "The amount of time spent searching, in milliseconds.", + "name": "search_time" }, { - "name": "ignore_malformed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "st" + ], + "description": "The number of search operations on the source index for the transform.", + "name": "search_total" }, { - "name": "null_value", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "aliases": [ + "si", + "sourceIndex" + ], + "description": "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.", + "name": "source_index" }, { - "name": "on_script_error", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "OnScriptError", - "namespace": "_types.mapping" - } - } + "aliases": [ + "s" + ], + "description": "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.", + "name": "state" }, { - "name": "script", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" - } - } + "aliases": [ + "tt" + ], + "description": "Indicates the type of transform: `batch` or `continuous`.", + "name": "transform_type" }, { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "stability": "experimental" - } - }, - "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", - "name": "time_series_dimension", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "aliases": [ + "tc" + ], + "description": "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.", + "name": "trigger_count" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "ip" - } + "aliases": [ + "v" + ], + "description": "The version of Elasticsearch that existed on the node when the transform\nwas created.", + "name": "version" } ], - "specLocation": "_types/mapping/specialized.ts#L74-L88" - }, - { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", "name": { - "name": "Murmur3HashProperty", - "namespace": "_types.mapping" + "name": "CatTransformColumn", + "namespace": "cat._types" }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "murmur3" - } - } - ], - "specLocation": "_types/mapping/specialized.ts#L90-L92" + "specLocation": "cat/_types/CatBase.ts#L640-L844" }, { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", + "kind": "type_alias", "name": { - "name": "TokenCountProperty", - "namespace": "_types.mapping" + "name": "CatTransformColumns", + "namespace": "cat._types" }, - "properties": [ - { - "name": "analyzer", - "required": false, - "type": { + "specLocation": "cat/_types/CatBase.ts#L845-L845", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CatTransformColumn", + "namespace": "cat._types" } - } - }, - { - "name": "boost", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CatTransformColumn", + "namespace": "cat._types" + } } } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "name": "active" }, { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "paused" + } + ], + "name": { + "name": "FollowerIndexStatus", + "namespace": "ccr.follow_info" + }, + "specLocation": "ccr/follow_info/types.ts#L37-L40" + }, + { + "kind": "enum", + "members": [ + { + "name": "NO" }, { - "name": "null_value", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "name": "YES" }, { - "name": "enable_position_increments", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "THROTTLE" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "token_count" - } + "name": "ALWAYS" } ], - "specLocation": "_types/mapping/specialized.ts#L94-L101" - }, - { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", "name": { - "name": "GeoPointProperty", - "namespace": "_types.mapping" + "name": "AllocationExplainDecision", + "namespace": "cluster.allocation_explain" }, - "properties": [ + "specLocation": "cluster/allocation_explain/types.ts#L33-L38" + }, + { + "kind": "enum", + "members": [ { - "name": "ignore_malformed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "yes" }, { - "name": "ignore_z_value", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "no" + }, + { + "name": "worse_balance" }, { - "name": "null_value", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "GeoLocation", - "namespace": "_types" - } - } + "name": "throttled" }, { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "awaiting_info" }, { - "name": "on_script_error", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "OnScriptError", - "namespace": "_types.mapping" - } - } + "name": "allocation_delayed" }, { - "name": "script", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" - } - } + "name": "no_valid_shard_copy" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "geo_point" - } + "name": "no_attempt" } ], - "specLocation": "_types/mapping/geo.ts#L24-L32" - }, - { - "description": "The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles\nand polygons.", - "docId": "geo-shape", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html", - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", "name": { - "name": "GeoShapeProperty", - "namespace": "_types.mapping" + "name": "Decision", + "namespace": "cluster.allocation_explain" }, - "properties": [ + "specLocation": "cluster/allocation_explain/types.ts#L92-L101" + }, + { + "kind": "enum", + "members": [ { - "name": "coerce", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "INDEX_CREATED" }, { - "name": "ignore_malformed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "CLUSTER_RECOVERED" }, { - "name": "ignore_z_value", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "INDEX_REOPENED" }, { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "DANGLING_INDEX_IMPORTED" }, { - "name": "orientation", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "GeoOrientation", - "namespace": "_types.mapping" - } - } + "name": "NEW_INDEX_RESTORED" }, { - "name": "strategy", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "GeoStrategy", - "namespace": "_types.mapping" - } - } + "name": "EXISTING_INDEX_RESTORED" }, { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "geo_shape" - } + "name": "REPLICA_ADDED" + }, + { + "name": "ALLOCATION_FAILED" + }, + { + "name": "NODE_LEFT" + }, + { + "name": "REROUTE_CANCELLED" + }, + { + "name": "REINITIALIZED" + }, + { + "name": "REALLOCATED_REPLICA" + }, + { + "name": "PRIMARY_FAILED" + }, + { + "name": "FORCED_EMPTY_PRIMARY" + }, + { + "name": "MANUAL_ALLOCATION" } ], - "specLocation": "_types/mapping/geo.ts#L41-L55" + "name": { + "name": "UnassignedInformationReason", + "namespace": "cluster.allocation_explain" + }, + "specLocation": "cluster/allocation_explain/types.ts#L138-L157" }, { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } + "kind": "type_alias", + "name": { + "name": "ClusterRemoteInfo", + "namespace": "cluster.remote_info" + }, + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L29-L30", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "ClusterRemoteSniffInfo", + "namespace": "cluster.remote_info" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ClusterRemoteProxyInfo", + "namespace": "cluster.remote_info" + } + } + ], + "kind": "union_of" }, + "variants": { + "kind": "internal_tag", + "tag": "mode" + } + }, + { "kind": "interface", "name": { - "name": "PointProperty", - "namespace": "_types.mapping" + "name": "ClusterRemoteSniffInfo", + "namespace": "cluster.remote_info" }, "properties": [ { - "name": "ignore_malformed", - "required": false, + "description": "The connection mode for the remote cluster.", + "name": "mode", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "sniff" } }, { - "name": "ignore_z_value", - "required": false, + "description": "If it is `true`, there is at least one open connection to the remote cluster.\nIf it is `false`, it means that the cluster no longer has an open connection to the remote cluster.\nIt does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost.", + "name": "connected", + "required": true, "type": { "kind": "instance_of", "type": { @@ -94509,68 +98396,46 @@ } }, { - "name": "null_value", - "required": false, + "description": "The maximum number of connections maintained for the remote cluster when sniff mode is configured.", + "name": "max_connections_per_cluster", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "name": "type", + "description": "The number of connected nodes in the remote cluster when sniff mode is configured.", + "name": "num_nodes_connected", "required": true, - "type": { - "kind": "literal_value", - "value": "point" - } - } - ], - "specLocation": "_types/mapping/geo.ts#L67-L72" - }, - { - "description": "The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as\nrectangles and polygons.", - "docId": "shape", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/shape.html", - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "ShapeProperty", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "coerce", - "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "ignore_malformed", - "required": false, + "description": "The initial connect timeout for remote cluster connections.", + "name": "initial_connect_timeout", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "name": "ignore_z_value", - "required": false, + "description": "If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster.", + "extDocId": "modules-cross-cluster-optional", + "name": "skip_unavailable", + "required": true, "type": { "kind": "instance_of", "type": { @@ -94580,89 +98445,68 @@ } }, { - "name": "orientation", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "GeoOrientation", - "namespace": "_types.mapping" - } - } - }, - { - "name": "type", + "description": "The initial seed transport addresses of the remote cluster when sniff mode is configured.", + "name": "seeds", "required": true, "type": { - "kind": "literal_value", - "value": "shape" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } } ], - "specLocation": "_types/mapping/geo.ts#L74-L86" + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L32-L56" }, { - "inherits": { - "type": { - "name": "NumberPropertyBase", - "namespace": "_types.mapping" - } - }, "kind": "interface", "name": { - "name": "ByteNumberProperty", - "namespace": "_types.mapping" + "name": "ClusterRemoteProxyInfo", + "namespace": "cluster.remote_info" }, "properties": [ { - "name": "type", + "description": "The connection mode for the remote cluster.", + "name": "mode", "required": true, "type": { "kind": "literal_value", - "value": "byte" + "value": "proxy" } }, { - "name": "null_value", - "required": false, + "description": "If it is `true`, there is at least one open connection to the remote cluster.\nIf it is `false`, it means that the cluster no longer has an open connection to the remote cluster.\nIt does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost.", + "name": "connected", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "byte", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/mapping/core.ts#L176-L179" - }, - { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "NumberPropertyBase", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "boost", - "required": false, + "description": "The initial connect timeout for remote cluster connections.", + "name": "initial_connect_timeout", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Duration", "namespace": "_types" } } }, { - "name": "coerce", - "required": false, + "description": "If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster.", + "extDocId": "modules-cross-cluster-optional", + "name": "skip_unavailable", + "required": true, "type": { "kind": "instance_of", "type": { @@ -94672,400 +98516,355 @@ } }, { - "name": "ignore_malformed", - "required": false, + "description": "The address for remote connections when proxy mode is configured.", + "name": "proxy_address", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "index", - "required": false, + "name": "server_name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "on_script_error", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "OnScriptError", - "namespace": "_types.mapping" - } - } - }, - { - "name": "script", - "required": false, + "description": "The number of open socket connections to the remote cluster when proxy mode is configured.", + "name": "num_proxy_sockets_connected", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "integer", "namespace": "_types" } } }, { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "stability": "experimental" - } - }, - "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", - "name": "time_series_metric", - "required": false, + "description": "The maximum number of socket connections to the remote cluster when proxy mode is configured.", + "name": "max_proxy_socket_connections", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TimeSeriesMetricType", - "namespace": "_types.mapping" + "name": "integer", + "namespace": "_types" } } }, { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "stability": "experimental" - } - }, - "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", - "name": "time_series_dimension", + "description": "This field is present and has a value of `::es_redacted::` only when the remote cluster is configured with the API key based model. Otherwise, the field is not present.", + "name": "cluster_credentials", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "_types/mapping/core.ts#L119-L139" + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L58-L83" }, { - "inherits": { - "type": { - "name": "NumberPropertyBase", - "namespace": "_types.mapping" - } + "kind": "type_alias", + "name": { + "name": "ConnectorConfiguration", + "namespace": "connector._types" }, + "specLocation": "connector/_types/Connector.ts#L101-L104", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ConnectorConfigProperties", + "namespace": "connector._types" + } + } + } + }, + { "kind": "interface", "name": { - "name": "DoubleNumberProperty", - "namespace": "_types.mapping" + "name": "ConnectorConfigProperties", + "namespace": "connector._types" }, "properties": [ { - "name": "type", - "required": true, + "name": "category", + "required": false, "type": { - "kind": "literal_value", - "value": "double" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "null_value", - "required": false, + "name": "default_value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "ScalarValue", "namespace": "_types" } } - } - ], - "specLocation": "_types/mapping/core.ts#L156-L159" - }, - { - "inherits": { - "type": { - "name": "NumberPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "FloatNumberProperty", - "namespace": "_types.mapping" - }, - "properties": [ + }, + { + "name": "depends_on", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Dependency", + "namespace": "connector._types" + } + } + } + }, { - "name": "type", + "name": "display", "required": true, "type": { - "kind": "literal_value", - "value": "float" + "kind": "instance_of", + "type": { + "name": "DisplayType", + "namespace": "connector._types" + } } }, { - "name": "null_value", - "required": false, + "name": "label", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/mapping/core.ts#L146-L149" - }, - { - "inherits": { - "type": { - "name": "NumberPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "HalfFloatNumberProperty", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "type", + "name": "options", "required": true, "type": { - "kind": "literal_value", - "value": "half_float" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SelectOption", + "namespace": "connector._types" + } + } } }, { - "name": "null_value", + "name": "order", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", + "name": "integer", "namespace": "_types" } } - } - ], - "specLocation": "_types/mapping/core.ts#L151-L154" - }, - { - "inherits": { - "type": { - "name": "NumberPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "IntegerNumberProperty", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "integer" - } }, { - "name": "null_value", + "name": "placeholder", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/mapping/core.ts#L161-L164" - }, - { - "inherits": { - "type": { - "name": "NumberPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "LongNumberProperty", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "type", + "name": "required", "required": true, "type": { - "kind": "literal_value", - "value": "long" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } }, { - "name": "null_value", - "required": false, + "name": "sensitive", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/mapping/core.ts#L166-L169" - }, - { - "inherits": { - "type": { - "name": "NumberPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "ScaledFloatNumberProperty", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "tooltip", + "required": false, "type": { - "kind": "literal_value", - "value": "scaled_float" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "null_value", + "name": "type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "ConnectorFieldType", + "namespace": "connector._types" } } }, { - "name": "scaling_factor", + "name": "ui_restrictions", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } - } - ], - "specLocation": "_types/mapping/core.ts#L186-L190" - }, - { - "inherits": { - "type": { - "name": "NumberPropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "ShortNumberProperty", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "name": "validations", + "required": false, "type": { - "kind": "literal_value", - "value": "short" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Validation", + "namespace": "connector._types" + } + } } }, { - "name": "null_value", - "required": false, + "name": "value", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "short", - "namespace": "_types" - } + "kind": "user_defined_value" } } ], - "specLocation": "_types/mapping/core.ts#L171-L174" + "specLocation": "connector/_types/Connector.ts#L83-L99" }, { - "inherits": { - "type": { - "name": "NumberPropertyBase", - "namespace": "_types.mapping" - } - }, "kind": "interface", "name": { - "name": "UnsignedLongNumberProperty", - "namespace": "_types.mapping" + "name": "Dependency", + "namespace": "connector._types" }, "properties": [ { - "name": "type", + "name": "field", "required": true, "type": { - "kind": "literal_value", - "value": "unsigned_long" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "null_value", - "required": false, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ulong", + "name": "ScalarValue", "namespace": "_types" } } } ], - "specLocation": "_types/mapping/core.ts#L181-L184" + "specLocation": "connector/_types/Connector.ts#L30-L33" }, { - "inherits": { - "type": { - "name": "RangePropertyBase", - "namespace": "_types.mapping" + "kind": "enum", + "members": [ + { + "name": "textbox" + }, + { + "name": "textarea" + }, + { + "name": "numeric" + }, + { + "name": "toggle" + }, + { + "name": "dropdown" } + ], + "name": { + "name": "DisplayType", + "namespace": "connector._types" }, + "specLocation": "connector/_types/Connector.ts#L35-L41" + }, + { "kind": "interface", "name": { - "name": "DateRangeProperty", - "namespace": "_types.mapping" + "name": "SelectOption", + "namespace": "connector._types" }, "properties": [ { - "name": "format", - "required": false, + "name": "label", + "required": true, "type": { "kind": "instance_of", "type": { @@ -95075,76 +98874,98 @@ } }, { - "name": "type", + "name": "value", "required": true, "type": { - "kind": "literal_value", - "value": "date_range" + "kind": "instance_of", + "type": { + "name": "ScalarValue", + "namespace": "_types" + } } } ], - "specLocation": "_types/mapping/range.ts#L29-L32" + "specLocation": "connector/_types/Connector.ts#L25-L28" }, { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" + "kind": "enum", + "members": [ + { + "name": "str" + }, + { + "name": "int" + }, + { + "name": "list" + }, + { + "name": "bool" } + ], + "name": { + "name": "ConnectorFieldType", + "namespace": "connector._types" }, - "kind": "interface", + "specLocation": "connector/_types/Connector.ts#L43-L48" + }, + { + "kind": "type_alias", "name": { - "name": "RangePropertyBase", - "namespace": "_types.mapping" + "name": "Validation", + "namespace": "connector._types" }, - "properties": [ - { - "name": "boost", - "required": false, - "type": { + "specLocation": "connector/_types/Connector.ts#L50-L56", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "LessThanValidation", + "namespace": "connector._types" } - } - }, - { - "name": "coerce", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "GreaterThanValidation", + "namespace": "connector._types" } - } - }, - { - "name": "index", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ListTypeValidation", + "namespace": "connector._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "IncludedInValidation", + "namespace": "connector._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RegexValidation", + "namespace": "connector._types" } } - } - ], - "specLocation": "_types/mapping/range.ts#L23-L27" + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "tag": "type" + } }, { - "inherits": { - "type": { - "name": "RangePropertyBase", - "namespace": "_types.mapping" - } - }, "kind": "interface", "name": { - "name": "DoubleRangeProperty", - "namespace": "_types.mapping" + "name": "LessThanValidation", + "namespace": "connector._types" }, "properties": [ { @@ -95152,47 +98973,28 @@ "required": true, "type": { "kind": "literal_value", - "value": "double_range" + "value": "less_than" } - } - ], - "specLocation": "_types/mapping/range.ts#L34-L36" - }, - { - "inherits": { - "type": { - "name": "RangePropertyBase", - "namespace": "_types.mapping" - } - }, - "kind": "interface", - "name": { - "name": "FloatRangeProperty", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "type", + "name": "constraint", "required": true, "type": { - "kind": "literal_value", - "value": "float_range" + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } } ], - "specLocation": "_types/mapping/range.ts#L38-L40" + "specLocation": "connector/_types/Connector.ts#L58-L61" }, { - "inherits": { - "type": { - "name": "RangePropertyBase", - "namespace": "_types.mapping" - } - }, "kind": "interface", "name": { - "name": "IntegerRangeProperty", - "namespace": "_types.mapping" + "name": "GreaterThanValidation", + "namespace": "connector._types" }, "properties": [ { @@ -95200,23 +99002,28 @@ "required": true, "type": { "kind": "literal_value", - "value": "integer_range" + "value": "greater_than" + } + }, + { + "name": "constraint", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } } } ], - "specLocation": "_types/mapping/range.ts#L42-L44" + "specLocation": "connector/_types/Connector.ts#L63-L66" }, { - "inherits": { - "type": { - "name": "RangePropertyBase", - "namespace": "_types.mapping" - } - }, "kind": "interface", "name": { - "name": "IpRangeProperty", - "namespace": "_types.mapping" + "name": "ListTypeValidation", + "namespace": "connector._types" }, "properties": [ { @@ -95224,23 +99031,28 @@ "required": true, "type": { "kind": "literal_value", - "value": "ip_range" + "value": "list_type" + } + }, + { + "name": "constraint", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } ], - "specLocation": "_types/mapping/range.ts#L46-L48" + "specLocation": "connector/_types/Connector.ts#L68-L71" }, { - "inherits": { - "type": { - "name": "RangePropertyBase", - "namespace": "_types.mapping" - } - }, "kind": "interface", "name": { - "name": "LongRangeProperty", - "namespace": "_types.mapping" + "name": "IncludedInValidation", + "namespace": "connector._types" }, "properties": [ { @@ -95248,23 +99060,31 @@ "required": true, "type": { "kind": "literal_value", - "value": "long_range" + "value": "included_in" + } + }, + { + "name": "constraint", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ScalarValue", + "namespace": "_types" + } + } } } ], - "specLocation": "_types/mapping/range.ts#L50-L52" + "specLocation": "connector/_types/Connector.ts#L73-L76" }, { - "inherits": { - "type": { - "name": "DocValuesPropertyBase", - "namespace": "_types.mapping" - } - }, "kind": "interface", - "name": { - "name": "IcuCollationProperty", - "namespace": "_types.mapping" + "name": { + "name": "RegexValidation", + "namespace": "connector._types" }, "properties": [ { @@ -95272,69 +99092,81 @@ "required": true, "type": { "kind": "literal_value", - "value": "icu_collation_keyword" + "value": "regex" } }, { - "name": "norms", - "required": false, + "name": "constraint", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - }, - { - "name": "index_options", - "required": false, + } + ], + "specLocation": "connector/_types/Connector.ts#L78-L81" + }, + { + "kind": "type_alias", + "name": { + "name": "ConnectorCustomScheduling", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L128-L128", + "type": { + "key": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "IndexOptions", - "namespace": "_types.mapping" - } + "name": "string", + "namespace": "_builtins" } }, - { - "description": "Should the field be searchable?", - "name": "index", - "required": false, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "name": "CustomScheduling", + "namespace": "connector._types" } - }, + } + } + }, + { + "kind": "interface", + "name": { + "name": "CustomScheduling", + "namespace": "connector._types" + }, + "properties": [ { - "description": "Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing.", - "name": "null_value", - "required": false, + "name": "configuration_overrides", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CustomSchedulingConfigurationOverrides", + "namespace": "connector._types" } } }, { - "name": "rules", - "required": false, + "name": "enabled", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "language", - "required": false, + "name": "interval", + "required": true, "type": { "kind": "instance_of", "type": { @@ -95344,19 +99176,19 @@ } }, { - "name": "country", + "name": "last_synced", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "name": "variant", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { @@ -95364,42 +99196,30 @@ "namespace": "_builtins" } } - }, - { - "name": "strength", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuCollationStrength", - "namespace": "_types.analysis" - } - } - }, - { - "name": "decomposition", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuCollationDecomposition", - "namespace": "_types.analysis" - } - } - }, + } + ], + "specLocation": "connector/_types/Connector.ts#L120-L126" + }, + { + "kind": "interface", + "name": { + "name": "CustomSchedulingConfigurationOverrides", + "namespace": "connector._types" + }, + "properties": [ { - "name": "alternate", + "name": "max_crawl_depth", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IcuCollationAlternate", - "namespace": "_types.analysis" + "name": "integer", + "namespace": "_types" } } }, { - "name": "case_level", + "name": "sitemap_discovery_disabled", "required": false, "type": { "kind": "instance_of", @@ -95410,1502 +99230,1777 @@ } }, { - "name": "case_first", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IcuCollationCaseFirst", - "namespace": "_types.analysis" - } - } - }, - { - "name": "numeric", + "name": "domain_allowlist", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "variable_top", + "name": "sitemap_urls", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "hiragana_quaternary_mode", + "name": "seed_urls", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } ], - "specLocation": "_types/mapping/specialized.ts#L103-L127" + "specLocation": "connector/_types/Connector.ts#L112-L118" }, { "kind": "enum", "members": [ { - "name": "disabled" + "name": "created" }, { - "name": "stored" + "name": "needs_configuration" }, { - "description": "Instead of storing source documents on disk exactly as you send them,\n Elasticsearch can reconstruct source content on the fly upon retrieval.", - "name": "synthetic" + "name": "configured" + }, + { + "name": "connected" + }, + { + "name": "error" } ], "name": { - "name": "SourceFieldMode", - "namespace": "_types.mapping" + "name": "ConnectorStatus", + "namespace": "connector._types" }, - "specLocation": "_types/mapping/meta-fields.ts#L67-L75" + "specLocation": "connector/_types/Connector.ts#L130-L136" }, { "kind": "enum", "members": [ { - "description": "Disables all operators.", - "name": "NONE" - }, - { - "description": "Enables the `+` AND operator.", - "name": "AND" - }, - { - "description": "Enables the `-` NOT operator.", - "name": "NOT" - }, - { - "description": "Enables the `\\|` OR operator.", - "name": "OR" - }, - { - "description": "Enables the `*` prefix operator.", - "name": "PREFIX" - }, - { - "description": "Enables the `\"` quotes operator used to search for phrases.", - "name": "PHRASE" - }, - { - "description": "Enables the `(` and `)` operators to control operator precedence.", - "name": "PRECEDENCE" - }, - { - "description": "Enables `\\` as an escape character.", - "name": "ESCAPE" - }, - { - "description": "Enables whitespace as split characters.", - "name": "WHITESPACE" - }, - { - "description": "Enables the `~N` operator after a word, where `N` is an integer denoting the allowed edit distance for matching.", - "name": "FUZZY" - }, - { - "description": "Enables the `~N` operator, after a phrase where `N` is the maximum number of positions allowed between matching tokens.\nSynonymous to `SLOP`.", - "name": "NEAR" - }, - { - "description": "Enables the `~N` operator, after a phrase where `N` is maximum number of positions allowed between matching tokens.\nSynonymous to `NEAR`.", - "name": "SLOP" + "name": "exclude" }, { - "description": "Enables all optional operators.", - "name": "ALL" + "name": "include" } ], "name": { - "name": "SimpleQueryStringFlag", - "namespace": "_types.query_dsl" + "name": "FilteringPolicy", + "namespace": "connector._types" }, - "specLocation": "_types/query_dsl/fulltext.ts#L729-L784" + "specLocation": "connector/_types/Connector.ts#L155-L158" }, { "kind": "enum", "members": [ { - "aliases": [ - "ae" - ], - "description": "For open anomaly detection jobs only, contains messages relating to the\nselection of a node to run the job.", - "name": "assignment_explanation" - }, - { - "aliases": [ - "bc", - "bucketsCount" - ], - "description": "The number of bucket results produced by the job.", - "name": "buckets.count" - }, - { - "aliases": [ - "btea", - "bucketsTimeExpAvg" - ], - "description": "Exponential moving average of all bucket processing times, in milliseconds.", - "name": "buckets.time.exp_avg" - }, - { - "aliases": [ - "bteah", - "bucketsTimeExpAvgHour" - ], - "description": "Exponentially-weighted moving average of bucket processing times calculated\nin a 1 hour time window, in milliseconds.", - "name": "buckets.time.exp_avg_hour" - }, - { - "aliases": [ - "btmax", - "bucketsTimeMax" - ], - "description": "Maximum among all bucket processing times, in milliseconds.", - "name": "buckets.time.max" - }, - { - "aliases": [ - "btmin", - "bucketsTimeMin" - ], - "description": "Minimum among all bucket processing times, in milliseconds.", - "name": "buckets.time.min" - }, - { - "aliases": [ - "btt", - "bucketsTimeTotal" - ], - "description": "Sum of all bucket processing times, in milliseconds.", - "name": "buckets.time.total" - }, - { - "aliases": [ - "db", - "dataBuckets" - ], - "description": "The number of buckets processed.", - "name": "data.buckets" - }, - { - "aliases": [ - "der", - "dataEarliestRecord" - ], - "description": "The timestamp of the earliest chronologically input document.", - "name": "data.earliest_record" - }, - { - "aliases": [ - "deb", - "dataEmptyBuckets" - ], - "description": "The number of buckets which did not contain any data.", - "name": "data.empty_buckets" - }, - { - "aliases": [ - "dib", - "dataInputBytes" - ], - "description": "The number of bytes of input data posted to the anomaly detection job.", - "name": "data.input_bytes" - }, - { - "aliases": [ - "dif", - "dataInputFields" - ], - "description": "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.", - "name": "data.input_fields" - }, - { - "aliases": [ - "dir", - "dataInputRecords" - ], - "description": "The number of input documents posted to the anomaly detection job.", - "name": "data.input_records" - }, - { - "aliases": [ - "did", - "dataInvalidDates" - ], - "description": "The number of input documents with either a missing date field or a date\nthat could not be parsed.", - "name": "data.invalid_dates" - }, - { - "aliases": [ - "dl", - "dataLast" - ], - "description": "The timestamp at which data was last analyzed, according to server time.", - "name": "data.last" - }, - { - "aliases": [ - "dleb", - "dataLastEmptyBucket" - ], - "description": "The timestamp of the last bucket that did not contain any data.", - "name": "data.last_empty_bucket" - }, - { - "aliases": [ - "dlsb", - "dataLastSparseBucket" - ], - "description": "The timestamp of the last bucket that was considered sparse.", - "name": "data.last_sparse_bucket" - }, - { - "aliases": [ - "dlr", - "dataLatestRecord" - ], - "description": "The timestamp of the latest chronologically input document.", - "name": "data.latest_record" - }, - { - "aliases": [ - "dmf", - "dataMissingFields" - ], - "description": "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.", - "name": "data.missing_fields" - }, - { - "aliases": [ - "doot", - "dataOutOfOrderTimestamps" - ], - "description": "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.", - "name": "data.out_of_order_timestamps" - }, - { - "aliases": [ - "dpf", - "dataProcessedFields" - ], - "description": "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.", - "name": "data.processed_fields" - }, - { - "aliases": [ - "dpr", - "dataProcessedRecords" - ], - "description": "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.", - "name": "data.processed_records" - }, - { - "aliases": [ - "dsb", - "dataSparseBuckets" - ], - "description": "The number of buckets that contained few data points compared to the\nexpected number of data points.", - "name": "data.sparse_buckets" - }, - { - "aliases": [ - "fmavg", - "forecastsMemoryAvg" - ], - "description": "The average memory usage in bytes for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.memory.avg" - }, - { - "aliases": [ - "fmmax", - "forecastsMemoryMax" - ], - "description": "The maximum memory usage in bytes for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.memory.max" - }, - { - "aliases": [ - "fmmin", - "forecastsMemoryMin" - ], - "description": "The minimum memory usage in bytes for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.memory.min" - }, - { - "aliases": [ - "fmt", - "forecastsMemoryTotal" - ], - "description": "The total memory usage in bytes for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.memory.total" - }, - { - "aliases": [ - "fravg", - "forecastsRecordsAvg" - ], - "description": "The average number of `m`odel_forecast` documents written for forecasts\nrelated to the anomaly detection job.", - "name": "forecasts.records.avg" - }, - { - "aliases": [ - "frmax", - "forecastsRecordsMax" - ], - "description": "The maximum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", - "name": "forecasts.records.max" - }, - { - "aliases": [ - "frmin", - "forecastsRecordsMin" - ], - "description": "The minimum number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", - "name": "forecasts.records.min" - }, - { - "aliases": [ - "frt", - "forecastsRecordsTotal" - ], - "description": "The total number of `model_forecast` documents written for forecasts\nrelated to the anomaly detection job.", - "name": "forecasts.records.total" + "name": "contains" }, { - "aliases": [ - "ftavg", - "forecastsTimeAvg" - ], - "description": "The average runtime in milliseconds for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.time.avg" + "name": "ends_with" }, { - "aliases": [ - "ftmax", - "forecastsTimeMax" - ], - "description": "The maximum runtime in milliseconds for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.time.max" + "name": "equals" }, { - "aliases": [ - "ftmin", - "forecastsTimeMin" - ], - "description": "The minimum runtime in milliseconds for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.time.min" + "name": "regex" }, { - "aliases": [ - "ftt", - "forecastsTimeTotal" - ], - "description": "The total runtime in milliseconds for forecasts related to the anomaly\ndetection job.", - "name": "forecasts.time.total" + "name": "starts_with" }, { - "aliases": [ - "ft", - "forecastsTotal" - ], - "description": "The number of individual forecasts currently available for the job.", - "name": "forecasts.total" + "codegenName": "greater_than", + "name": ">" }, { - "description": "Identifier for the anomaly detection job.", - "name": "id" + "codegenName": "less_than", + "name": "<" + } + ], + "name": { + "name": "FilteringRuleRule", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L160-L168" + }, + { + "kind": "enum", + "members": [ + { + "name": "edited" }, { - "aliases": [ - "mbaf", - "modelBucketAllocationFailures" - ], - "description": "The number of buckets for which new entities in incoming data were not\nprocessed due to insufficient model memory.", - "name": "model.bucket_allocation_failures" + "name": "invalid" }, { - "aliases": [ - "mbf", - "modelByFields" - ], - "description": "The number of by field values that were analyzed by the models. This value\nis cumulative for all detectors in the job.", - "name": "model.by_fields" + "name": "valid" + } + ], + "name": { + "name": "FilteringValidationState", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L186-L190" + }, + { + "kind": "enum", + "members": [ + { + "name": "on_demand" }, { - "aliases": [ - "mb", - "modelBytes" - ], - "description": "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.", - "name": "model.bytes" + "name": "scheduled" + } + ], + "name": { + "name": "SyncJobTriggerMethod", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/SyncJob.ts#L48-L51" + }, + { + "kind": "enum", + "members": [ + { + "name": "full" }, { - "aliases": [ - "mbe", - "modelBytesExceeded" - ], - "description": "The number of bytes over the high limit for memory usage at the last\nallocation failure.", - "name": "model.bytes_exceeded" + "name": "incremental" }, { - "aliases": [ - "mcs", - "modelCategorizationStatus" - ], - "description": "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.", - "name": "model.categorization_status" + "name": "access_control" + } + ], + "name": { + "name": "SyncJobType", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/SyncJob.ts#L42-L46" + }, + { + "kind": "enum", + "members": [ + { + "name": "canceling" }, { - "aliases": [ - "mcdc", - "modelCategorizedDocCount" - ], - "description": "The number of documents that have had a field categorized.", - "name": "model.categorized_doc_count" + "name": "canceled" }, { - "aliases": [ - "mdcc", - "modelDeadCategoryCount" - ], - "description": "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.", - "name": "model.dead_category_count" + "name": "completed" }, { - "aliases": [ - "mdcc", - "modelFailedCategoryCount" - ], - "description": "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.", - "name": "model.failed_category_count" + "name": "error" }, { - "aliases": [ - "mfcc", - "modelFrequentCategoryCount" - ], - "description": "The number of categories that match more than 1% of categorized documents.", - "name": "model.frequent_category_count" + "name": "in_progress" }, { - "aliases": [ - "mlt", - "modelLogTime" - ], - "description": "The timestamp when the model stats were gathered, according to server time.", - "name": "model.log_time" + "name": "pending" }, { - "aliases": [ - "mml", - "modelMemoryLimit" - ], - "description": "The timestamp when the model stats were gathered, according to server time.", - "name": "model.memory_limit" + "name": "suspended" + } + ], + "name": { + "name": "SyncStatus", + "namespace": "connector._types" + }, + "specLocation": "connector/_types/Connector.ts#L138-L146" + }, + { + "kind": "enum", + "members": [ + { + "name": "geo_match" }, { - "aliases": [ - "mms", - "modelMemoryStatus" - ], - "description": "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.", - "name": "model.memory_status" + "name": "match" }, { - "aliases": [ - "mof", - "modelOverFields" - ], - "description": "The number of over field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.", - "name": "model.over_fields" + "name": "range" + } + ], + "name": { + "name": "PolicyType", + "namespace": "enrich._types" + }, + "specLocation": "enrich/_types/Policy.ts#L28-L32" + }, + { + "kind": "enum", + "members": [ + { + "name": "SCHEDULED" }, { - "aliases": [ - "mpf", - "modelPartitionFields" - ], - "description": "The number of partition field values that were analyzed by the models. This\nvalue is cumulative for all detectors in the job.", - "name": "model.partition_fields" + "name": "RUNNING" }, { - "aliases": [ - "mrcc", - "modelRareCategoryCount" - ], - "description": "The number of categories that match just one categorized document.", - "name": "model.rare_category_count" + "name": "COMPLETE" }, { - "aliases": [ - "mt", - "modelTimestamp" - ], - "description": "The timestamp of the last record when the model stats were gathered.", - "name": "model.timestamp" + "name": "FAILED" + } + ], + "name": { + "name": "EnrichPolicyPhase", + "namespace": "enrich.execute_policy" + }, + "specLocation": "enrich/execute_policy/types.ts#L24-L29" + }, + { + "kind": "enum", + "members": [ + { + "description": "Return the most recent matches, similar to the Unix tail command.", + "name": "tail" }, { - "aliases": [ - "mtcc", - "modelTotalCategoryCount" - ], - "description": "The number of categories created by categorization.", - "name": "model.total_category_count" + "description": "Return the earliest matches, similar to the Unix head command.", + "name": "head" + } + ], + "name": { + "name": "ResultPosition", + "namespace": "eql.search" + }, + "specLocation": "eql/search/types.ts#L20-L32" + }, + { + "kind": "enum", + "members": [ + { + "name": "csv" }, { - "aliases": [ - "na", - "nodeAddress" - ], - "description": "The network address of the node that runs the job. This information is\navailable only for open jobs.", - "name": "node.address" + "name": "json" }, { - "aliases": [ - "ne", - "nodeEphemeralId" - ], - "description": "The ephemeral ID of the node that runs the job. This information is\navailable only for open jobs.", - "name": "node.ephemeral_id" + "name": "tsv" }, { - "aliases": [ - "ni", - "nodeId" - ], - "description": "The unique identifier of the node that runs the job. This information is\navailable only for open jobs.", - "name": "node.id" + "name": "txt" }, { - "aliases": [ - "nn", - "nodeName" - ], - "description": "The name of the node that runs the job. This information is available only\nfor open jobs.", - "name": "node.name" + "name": "yaml" }, { - "aliases": [ - "ot" - ], - "description": "For open jobs only, the elapsed time for which the job has been open.", - "name": "opened_time" + "name": "cbor" }, { - "aliases": [ - "s" - ], - "description": "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.", - "name": "state" + "name": "smile" + }, + { + "name": "arrow" } ], "name": { - "name": "CatAnomalyDetectorColumn", - "namespace": "cat._types" + "name": "EsqlFormat", + "namespace": "esql._types" }, - "specLocation": "cat/_types/CatBase.ts#L32-L401" + "specLocation": "esql/_types/QueryParameters.ts#L20-L29" }, { "kind": "type_alias", "name": { - "name": "CatAnonalyDetectorColumns", - "namespace": "cat._types" + "name": "TableValuesIntegerValue", + "namespace": "esql._types" }, - "specLocation": "cat/_types/CatBase.ts#L402-L404", + "specLocation": "esql/_types/TableValuesContainer.ts#L30-L30", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "TableValuesKeywordValue", + "namespace": "esql._types" + }, + "specLocation": "esql/_types/TableValuesContainer.ts#L31-L31", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "TableValuesLongDouble", + "namespace": "esql._types" + }, + "specLocation": "esql/_types/TableValuesContainer.ts#L33-L33", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" + } + } + } + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "TableValuesLongValue", + "namespace": "esql._types" + }, + "specLocation": "esql/_types/TableValuesContainer.ts#L32-L32", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "kind": "union_of" + } + }, + { + "kind": "type_alias", + "name": { + "name": "Checkpoint", + "namespace": "fleet._types" + }, + "specLocation": "fleet/_types/Checkpoints.ts#L22-L22", + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "kind": "type_alias", + "name": { + "name": "LifecycleExplain", + "namespace": "ilm.explain_lifecycle" + }, + "specLocation": "ilm/explain_lifecycle/types.ts#L64-L67", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "CatAnomalyDetectorColumn", - "namespace": "cat._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CatAnomalyDetectorColumn", - "namespace": "cat._types" - } + "name": "LifecycleExplainManaged", + "namespace": "ilm.explain_lifecycle" + } + }, + { + "kind": "instance_of", + "type": { + "name": "LifecycleExplainUnmanaged", + "namespace": "ilm.explain_lifecycle" + } + } + ], + "kind": "union_of" + }, + "variants": { + "kind": "internal_tag", + "tag": "managed" + } + }, + { + "kind": "interface", + "name": { + "name": "LifecycleExplainManaged", + "namespace": "ilm.explain_lifecycle" + }, + "properties": [ + { + "name": "action", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "action_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } + } + }, + { + "name": "action_time_millis", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" } } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ + }, { - "aliases": [ - "assignment_explanation" - ], - "description": "For started datafeeds only, contains messages relating to the selection of\na node.", - "name": "ae" + "name": "age", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } }, { - "aliases": [ - "buckets.count", - "bucketsCount" - ], - "description": "The number of buckets processed.", - "name": "bc" + "name": "failed_step", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } }, { - "description": "A numerical character string that uniquely identifies the datafeed.", - "name": "id" + "name": "failed_step_retry_count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "aliases": [ - "node.address", - "nodeAddress" - ], - "description": "For started datafeeds only, the network address of the node where the\ndatafeed is started.", - "name": "na" + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } }, { - "aliases": [ - "node.ephemeral_id", - "nodeEphemeralId" - ], - "description": "For started datafeeds only, the ephemeral ID of the node where the\ndatafeed is started.", - "name": "ne" + "name": "index_creation_date", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } + } }, { - "aliases": [ - "node.id", - "nodeId" - ], - "description": "For started datafeeds only, the unique identifier of the node where the\ndatafeed is started.", - "name": "ni" + "name": "index_creation_date_millis", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } }, { - "aliases": [ - "node.name", - "nodeName" - ], - "description": "For started datafeeds only, the name of the node where the datafeed is\nstarted.", - "name": "nn" + "name": "is_auto_retryable_error", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "search.bucket_avg", - "searchBucketAvg" - ], - "description": "The average search time per bucket, in milliseconds.", - "name": "sba" + "name": "lifecycle_date", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } + } }, { - "aliases": [ - "search.count", - "searchCount" - ], - "description": "The number of searches run by the datafeed.", - "name": "sc" + "name": "lifecycle_date_millis", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } }, { - "aliases": [ - "search.exp_avg_hour", - "searchExpAvgHour" - ], - "description": "The exponential average search time per hour, in milliseconds.", - "name": "seah" + "name": "managed", + "required": true, + "type": { + "kind": "literal_value", + "value": true + } }, { - "aliases": [ - "search.time", - "searchTime" - ], - "description": "The total time the datafeed spent searching, in milliseconds.", - "name": "st" + "name": "phase", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } }, { - "aliases": [ - "state" - ], - "description": "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.", - "name": "s" - } - ], - "name": { - "name": "CatDatafeedColumn", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L405-L471" - }, - { - "kind": "type_alias", - "name": { - "name": "CatDatafeedColumns", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L559-L559", - "type": { - "items": [ - { + "name": "phase_time", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CatDatafeedColumn", - "namespace": "cat._types" + "name": "DateTime", + "namespace": "_types" } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CatDatafeedColumn", - "namespace": "cat._types" + } + }, + { + "name": "phase_time_millis", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" } } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ - { - "aliases": [ - "ae" - ], - "description": "Contains messages relating to the selection of a node.", - "name": "assignment_explanation" }, { - "aliases": [ - "ct", - "createTime" - ], - "description": "The time when the data frame analytics job was created.", - "name": "create_time" + "name": "policy", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } }, { - "aliases": [ - "d" - ], - "description": "A description of a job.", - "name": "description" + "name": "previous_step_info", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } }, { - "aliases": [ - "di", - "destIndex" - ], - "description": "Name of the destination index.", - "name": "dest_index" + "name": "repository_name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "fr", - "failureReason" - ], - "description": "Contains messages about the reason why a data frame analytics job failed.", - "name": "failure_reason" + "name": "snapshot_name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "description": "Identifier for the data frame analytics job.", - "name": "id" + "name": "shrink_index_name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "mml", - "modelMemoryLimit" - ], - "description": "The approximate maximum amount of memory resources that are permitted for\nthe data frame analytics job.", - "name": "model_memory_limit" + "name": "step", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } }, { - "aliases": [ - "na", - "nodeAddress" - ], - "description": "The network address of the node that the data frame analytics job is\nassigned to.", - "name": "node.address" + "name": "step_info", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } }, { - "aliases": [ - "ne", - "nodeEphemeralId" - ], - "description": "The ephemeral ID of the node that the data frame analytics job is assigned\nto.", - "name": "node.ephemeral_id" + "name": "step_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } + } }, { - "aliases": [ - "ni", - "nodeId" - ], - "description": "The unique identifier of the node that the data frame analytics job is\nassigned to.", - "name": "node.id" + "name": "step_time_millis", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } }, { - "aliases": [ - "nn", - "nodeName" - ], - "description": "The name of the node that the data frame analytics job is assigned to.", - "name": "node.name" + "name": "phase_execution", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "LifecycleExplainPhaseExecution", + "namespace": "ilm.explain_lifecycle" + } + } }, { - "aliases": [ - "p" - ], - "description": "The progress report of the data frame analytics job by phase.", - "name": "progress" - }, + "name": "time_since_index_creation", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "ilm/explain_lifecycle/types.ts#L27-L57" + }, + { + "kind": "interface", + "name": { + "name": "LifecycleExplainPhaseExecution", + "namespace": "ilm.explain_lifecycle" + }, + "properties": [ { - "aliases": [ - "si", - "sourceIndex" - ], - "description": "Name of the source index.", - "name": "source_index" + "name": "phase_definition", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Phase", + "namespace": "ilm._types" + } + } }, { - "aliases": [ - "s" - ], - "description": "Current state of the data frame analytics job.", - "name": "state" + "name": "policy", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } }, { - "aliases": [ - "t" - ], - "description": "The type of analysis that the data frame analytics job performs.", - "name": "type" + "name": "version", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } }, { - "aliases": [ - "v" - ], - "description": "The Elasticsearch version number in which the data frame analytics job was\ncreated.", - "name": "version" + "name": "modified_date_in_millis", + "required": true, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } } ], - "name": { - "name": "CatDfaColumn", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L472-L557" + "specLocation": "ilm/explain_lifecycle/types.ts#L69-L74" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "CatDfaColumns", - "namespace": "cat._types" + "name": "Phase", + "namespace": "ilm._types" }, - "specLocation": "cat/_types/CatBase.ts#L558-L558", - "type": { - "items": [ - { + "properties": [ + { + "name": "actions", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CatDfaColumn", - "namespace": "cat._types" + "name": "Actions", + "namespace": "ilm._types" } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CatDfaColumn", - "namespace": "cat._types" - } + } + }, + { + "name": "min_age", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" } } - ], - "kind": "union_of" - } + } + ], + "specLocation": "ilm/_types/Phase.ts#L26-L29" }, { - "kind": "enum", - "members": [ - { - "aliases": [ - "ct" - ], - "description": "The time when the trained model was created.", - "name": "create_time" - }, + "kind": "interface", + "name": { + "name": "Actions", + "namespace": "ilm._types" + }, + "properties": [ { - "aliases": [ - "c", - "createdBy" - ], - "description": "Information on the creator of the trained model.", - "name": "created_by" + "description": "Phases allowed: warm, cold.", + "name": "allocate", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AllocateAction", + "namespace": "ilm._types" + } + } }, { - "aliases": [ - "df", - "dataFrameAnalytics", - "dfid" - ], - "description": "Identifier for the data frame analytics job that created the model. Only\ndisplayed if it is still available.", - "name": "data_frame_analytics_id" + "description": "Phases allowed: delete.", + "name": "delete", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DeleteAction", + "namespace": "ilm._types" + } + } }, { - "aliases": [ - "d" - ], - "description": "The description of the trained model.", - "name": "description" + "description": "Phases allowed: hot, warm, cold.", + "name": "downsample", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DownsampleAction", + "namespace": "ilm._types" + } + } }, { - "aliases": [ - "hs", - "modelHeapSize" - ], - "description": "The estimated heap size to keep the trained model in memory.", - "name": "heap_size" + "deprecation": { + "description": "", + "version": "7.0.0" + }, + "description": "The freeze action is a noop in 8.x", + "name": "freeze", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "EmptyObject", + "namespace": "_types" + } + } }, { - "description": "Identifier for the trained model.", - "name": "id" + "description": "Phases allowed: hot, warm.", + "name": "forcemerge", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ForceMergeAction", + "namespace": "ilm._types" + } + } }, { - "aliases": [ - "ic", - "ingestCount" - ], - "description": "The total number of documents that are processed by the model.", - "name": "ingest.count" + "description": "Phases allowed: warm, cold.", + "name": "migrate", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "MigrateAction", + "namespace": "ilm._types" + } + } }, { - "aliases": [ - "icurr", - "ingestCurrent" - ], - "description": "The total number of document that are currently being handled by the\ntrained model.", - "name": "ingest.current" + "description": "Phases allowed: hot, warm, cold.", + "name": "readonly", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "EmptyObject", + "namespace": "_types" + } + } }, { - "aliases": [ - "if", - "ingestFailed" - ], - "description": "The total number of failed ingest attempts with the trained model.", - "name": "ingest.failed" + "description": "Phases allowed: hot.", + "name": "rollover", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RolloverAction", + "namespace": "ilm._types" + } + } }, { - "aliases": [ - "ip", - "ingestPipelines" - ], - "description": "The total number of ingest pipelines that are referencing the trained\nmodel.", - "name": "ingest.pipelines" + "description": "Phases allowed: hot, warm, cold.", + "name": "set_priority", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SetPriorityAction", + "namespace": "ilm._types" + } + } }, { - "aliases": [ - "it", - "ingestTime" - ], - "description": "The total time that is spent processing documents with the trained model.", - "name": "ingest.time" + "description": "Phases allowed: hot, cold, frozen.", + "name": "searchable_snapshot", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SearchableSnapshotAction", + "namespace": "ilm._types" + } + } }, { - "aliases": [ - "l" - ], - "description": "The license level of the trained model.", - "name": "license" + "description": "Phases allowed: hot, warm.", + "name": "shrink", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ShrinkAction", + "namespace": "ilm._types" + } + } }, { - "aliases": [ - "o", - "modelOperations" - ], - "description": "The estimated number of operations to use the trained model. This number\nhelps measuring the computational complexity of the model.", - "name": "operations" + "description": "Phases allowed: hot, warm, cold, frozen.", + "name": "unfollow", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "EmptyObject", + "namespace": "_types" + } + } }, { - "aliases": [ - "v" - ], - "description": "The Elasticsearch version number in which the trained model was created.", - "name": "version" + "description": "Phases allowed: delete.", + "name": "wait_for_snapshot", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "WaitForSnapshotAction", + "namespace": "ilm._types" + } + } } ], - "name": { - "name": "CatTrainedModelsColumn", - "namespace": "cat._types" - }, - "specLocation": "cat/_types/CatBase.ts#L561-L635" + "specLocation": "ilm/_types/Phase.ts#L39-L93" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "CatTrainedModelsColumns", - "namespace": "cat._types" + "name": "AllocateAction", + "namespace": "ilm._types" }, - "specLocation": "cat/_types/CatBase.ts#L636-L638", - "type": { - "items": [ - { + "properties": [ + { + "name": "number_of_replicas", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "CatTrainedModelsColumn", - "namespace": "cat._types" + "name": "integer", + "namespace": "_types" } - }, - { - "kind": "array_of", + } + }, + { + "name": "total_shards_per_node", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "name": "include", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "CatTrainedModelsColumn", - "namespace": "cat._types" + "name": "string", + "namespace": "_builtins" } } } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ - { - "aliases": [ - "cldt" - ], - "description": "The timestamp when changes were last detected in the source indices.", - "name": "changes_last_detection_time" - }, - { - "aliases": [ - "cp" - ], - "description": "The sequence number for the checkpoint.", - "name": "checkpoint" - }, - { - "aliases": [ - "cdtea", - "checkpointTimeExpAvg" - ], - "description": "Exponential moving average of the duration of the checkpoint, in\nmilliseconds.", - "name": "checkpoint_duration_time_exp_avg" - }, - { - "aliases": [ - "c", - "checkpointProgress" - ], - "description": "The progress of the next checkpoint that is currently in progress.", - "name": "checkpoint_progress" - }, - { - "aliases": [ - "ct", - "createTime" - ], - "description": "The time the transform was created.", - "name": "create_time" - }, - { - "aliases": [ - "dtime" - ], - "description": "The amount of time spent deleting, in milliseconds.", - "name": "delete_time" - }, - { - "aliases": [ - "d" - ], - "description": "The description of the transform.", - "name": "description" - }, - { - "aliases": [ - "di", - "destIndex" - ], - "description": "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.", - "name": "dest_index" - }, - { - "aliases": [ - "docd" - ], - "description": "The number of documents that have been deleted from the destination index\ndue to the retention policy for this transform.", - "name": "documents_deleted" }, { - "aliases": [ - "doci" - ], - "description": "The number of documents that have been indexed into the destination index\nfor the transform.", - "name": "documents_indexed" + "name": "exclude", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } }, { - "aliases": [ - "dps" - ], - "description": "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.", - "name": "docs_per_second" - }, + "name": "require", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "ilm/_types/Phase.ts#L133-L139" + }, + { + "kind": "interface", + "name": { + "name": "DeleteAction", + "namespace": "ilm._types" + }, + "properties": [ { - "aliases": [ - "docp" - ], - "description": "The number of documents that have been processed from the source index of\nthe transform.", - "name": "documents_processed" - }, + "name": "delete_searchable_snapshot", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ilm/_types/Phase.ts#L149-L151" + }, + { + "kind": "interface", + "name": { + "name": "DownsampleAction", + "namespace": "ilm._types" + }, + "properties": [ { - "aliases": [ - "f" - ], - "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`. The default\nvalue is `1m`.", - "name": "frequency" + "name": "fixed_interval", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DurationLarge", + "namespace": "_types" + } + } }, { - "description": "Identifier for the transform.", - "name": "id" - }, + "name": "wait_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "ilm/_types/Phase.ts#L112-L115" + }, + { + "kind": "interface", + "name": { + "name": "ForceMergeAction", + "namespace": "ilm._types" + }, + "properties": [ { - "aliases": [ - "if" - ], - "description": "The number of indexing failures.", - "name": "index_failure" + "name": "max_num_segments", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "aliases": [ - "itime" - ], - "description": "The amount of time spent indexing, in milliseconds.", - "name": "index_time" - }, + "name": "index_codec", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ilm/_types/Phase.ts#L123-L126" + }, + { + "kind": "interface", + "name": { + "name": "MigrateAction", + "namespace": "ilm._types" + }, + "properties": [ { - "aliases": [ - "it" - ], - "description": "The number of index operations.", - "name": "index_total" - }, + "name": "enabled", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ilm/_types/Phase.ts#L141-L143" + }, + { + "kind": "interface", + "name": { + "name": "RolloverAction", + "namespace": "ilm._types" + }, + "properties": [ { - "aliases": [ - "idea" - ], - "description": "Exponential moving average of the number of new documents that have been\nindexed.", - "name": "indexed_documents_exp_avg" + "name": "max_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } }, { - "aliases": [ - "lst", - "lastSearchTime" - ], - "description": "The timestamp of the last search in the source indices. This field is only\nshown if the transform is running.", - "name": "last_search_time" + "name": "max_primary_shard_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } }, { - "aliases": [ - "mpsz" - ], - "description": "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`.", - "name": "max_page_search_size" + "name": "max_age", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } }, { - "aliases": [ - "pp" - ], - "description": "The number of search or bulk index operations processed. Documents are\nprocessed in batches instead of individually.", - "name": "pages_processed" + "name": "max_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } }, { - "aliases": [ - "p" - ], - "description": "The unique identifier for an ingest pipeline.", - "name": "pipeline" + "name": "max_primary_shard_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } }, { - "aliases": [ - "pdea" - ], - "description": "Exponential moving average of the number of documents that have been\nprocessed.", - "name": "processed_documents_exp_avg" + "name": "min_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } }, { - "aliases": [ - "pt" - ], - "description": "The amount of time spent processing results, in milliseconds.", - "name": "processing_time" + "name": "min_primary_shard_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } }, { - "aliases": [ - "r" - ], - "description": "If a transform has a `failed` state, this property provides details about\nthe reason for the failure.", - "name": "reason" + "name": "min_age", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } }, { - "aliases": [ - "sf" - ], - "description": "The number of search failures.", - "name": "search_failure" + "name": "min_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } }, { - "aliases": [ - "stime" - ], - "description": "The amount of time spent searching, in milliseconds.", - "name": "search_time" - }, + "name": "min_primary_shard_docs", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "ilm/_types/Phase.ts#L99-L110" + }, + { + "kind": "interface", + "name": { + "name": "SetPriorityAction", + "namespace": "ilm._types" + }, + "properties": [ { - "aliases": [ - "st" - ], - "description": "The number of search operations on the source index for the transform.", - "name": "search_total" - }, + "name": "priority", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "ilm/_types/Phase.ts#L95-L97" + }, + { + "kind": "interface", + "name": { + "name": "SearchableSnapshotAction", + "namespace": "ilm._types" + }, + "properties": [ { - "aliases": [ - "si", - "sourceIndex" - ], - "description": "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.", - "name": "source_index" + "name": "snapshot_repository", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "aliases": [ - "s" - ], - "description": "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.", - "name": "state" - }, + "name": "force_merge_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ilm/_types/Phase.ts#L128-L131" + }, + { + "kind": "interface", + "name": { + "name": "ShrinkAction", + "namespace": "ilm._types" + }, + "properties": [ { - "aliases": [ - "tt" - ], - "description": "Indicates the type of transform: `batch` or `continuous`.", - "name": "transform_type" + "name": "number_of_shards", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "aliases": [ - "tc" - ], - "description": "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.", - "name": "trigger_count" + "name": "max_primary_shard_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } }, { - "aliases": [ - "v" - ], - "description": "The version of Elasticsearch that existed on the node when the transform\nwas created.", - "name": "version" + "name": "allow_write_after_shrink", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], + "specLocation": "ilm/_types/Phase.ts#L117-L121" + }, + { + "kind": "interface", "name": { - "name": "CatTransformColumn", - "namespace": "cat._types" + "name": "WaitForSnapshotAction", + "namespace": "ilm._types" }, - "specLocation": "cat/_types/CatBase.ts#L640-L844" + "properties": [ + { + "name": "policy", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ilm/_types/Phase.ts#L145-L147" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "CatTransformColumns", - "namespace": "cat._types" + "name": "LifecycleExplainUnmanaged", + "namespace": "ilm.explain_lifecycle" }, - "specLocation": "cat/_types/CatBase.ts#L845-L845", - "type": { - "items": [ - { + "properties": [ + { + "name": "index", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "CatTransformColumn", - "namespace": "cat._types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CatTransformColumn", - "namespace": "cat._types" - } + "name": "IndexName", + "namespace": "_types" } } - ], - "kind": "union_of" - } + }, + { + "name": "managed", + "required": true, + "type": { + "kind": "literal_value", + "value": false + } + } + ], + "specLocation": "ilm/explain_lifecycle/types.ts#L59-L62" }, { + "esQuirk": "This is a boolean that evolved into an enum. ES also accepts plain booleans for true and false.", "kind": "enum", "members": [ { - "name": "active" + "name": "true" }, { - "name": "paused" + "name": "false" + }, + { + "name": "checksum" } ], "name": { - "name": "FollowerIndexStatus", - "namespace": "ccr.follow_info" + "name": "IndexCheckOnStartup", + "namespace": "indices._types" }, - "specLocation": "ccr/follow_info/types.ts#L37-L40" + "specLocation": "indices/_types/IndexSettings.ts#L270-L277" }, { "kind": "enum", "members": [ { - "name": "NO" + "name": "all" }, { - "name": "YES" + "name": "primaries" }, { - "name": "THROTTLE" + "name": "new_primaries" }, { - "name": "ALWAYS" + "name": "none" } ], "name": { - "name": "AllocationExplainDecision", - "namespace": "cluster.allocation_explain" + "name": "IndexRoutingAllocationOptions", + "namespace": "indices._types" }, - "specLocation": "cluster/allocation_explain/types.ts#L33-L38" + "specLocation": "indices/_types/IndexRouting.ts#L38-L43" }, { "kind": "enum", "members": [ { - "name": "yes" - }, - { - "name": "no" - }, - { - "name": "worse_balance" - }, - { - "name": "throttled" - }, - { - "name": "awaiting_info" + "name": "all" }, { - "name": "allocation_delayed" + "name": "primaries" }, { - "name": "no_valid_shard_copy" + "name": "replicas" }, { - "name": "no_attempt" + "name": "none" } ], "name": { - "name": "Decision", - "namespace": "cluster.allocation_explain" + "name": "IndexRoutingRebalanceOptions", + "namespace": "indices._types" }, - "specLocation": "cluster/allocation_explain/types.ts#L92-L101" + "specLocation": "indices/_types/IndexRouting.ts#L45-L50" }, { "kind": "enum", "members": [ { - "name": "INDEX_CREATED" - }, - { - "name": "CLUSTER_RECOVERED" - }, - { - "name": "INDEX_REOPENED" - }, - { - "name": "DANGLING_INDEX_IMPORTED" - }, - { - "name": "NEW_INDEX_RESTORED" - }, - { - "name": "EXISTING_INDEX_RESTORED" - }, - { - "name": "REPLICA_ADDED" + "codegenName": "ilm", + "name": "Index Lifecycle Management" }, { - "name": "ALLOCATION_FAILED" + "codegenName": "datastream", + "name": "Data stream lifecycle" }, { - "name": "NODE_LEFT" - }, + "codegenName": "unmanaged", + "name": "Unmanaged" + } + ], + "name": { + "name": "ManagedBy", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/DataStream.ts#L32-L37" + }, + { + "kind": "enum", + "members": [ { - "name": "REROUTE_CANCELLED" + "codegenName": "last", + "name": "_last" }, { - "name": "REINITIALIZED" - }, + "codegenName": "first", + "name": "_first" + } + ], + "name": { + "name": "SegmentSortMissing", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/IndexSegmentSort.ts#L43-L46" + }, + { + "kind": "enum", + "members": [ { - "name": "REALLOCATED_REPLICA" + "aliases": [ + "MIN" + ], + "name": "min" }, { - "name": "PRIMARY_FAILED" - }, + "aliases": [ + "MAX" + ], + "name": "max" + } + ], + "name": { + "name": "SegmentSortMode", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/IndexSegmentSort.ts#L36-L41" + }, + { + "kind": "enum", + "members": [ { - "name": "FORCED_EMPTY_PRIMARY" + "aliases": [ + "ASC" + ], + "name": "asc" }, { - "name": "MANUAL_ALLOCATION" + "aliases": [ + "DESC" + ], + "name": "desc" } ], "name": { - "name": "UnassignedInformationReason", - "namespace": "cluster.allocation_explain" + "name": "SegmentSortOrder", + "namespace": "indices._types" }, - "specLocation": "cluster/allocation_explain/types.ts#L138-L157" + "specLocation": "indices/_types/IndexSegmentSort.ts#L29-L34" }, { "kind": "type_alias", "name": { - "name": "ClusterRemoteInfo", - "namespace": "cluster.remote_info" + "name": "SettingsSimilarity", + "namespace": "indices._types" }, - "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L29-L30", + "specLocation": "indices/_types/IndexSettings.ts#L178-L190", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "ClusterRemoteSniffInfo", - "namespace": "cluster.remote_info" + "name": "SettingsSimilarityBm25", + "namespace": "indices._types" } }, { "kind": "instance_of", "type": { - "name": "ClusterRemoteProxyInfo", - "namespace": "cluster.remote_info" + "name": "SettingsSimilarityBoolean", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SettingsSimilarityDfi", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SettingsSimilarityDfr", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SettingsSimilarityIb", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SettingsSimilarityLmd", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SettingsSimilarityLmj", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SettingsSimilarityScripted", + "namespace": "indices._types" } } ], @@ -96913,758 +101008,636 @@ }, "variants": { "kind": "internal_tag", - "tag": "mode" + "nonExhaustive": true, + "tag": "type" } }, { "kind": "interface", "name": { - "name": "ClusterRemoteSniffInfo", - "namespace": "cluster.remote_info" + "name": "SettingsSimilarityBm25", + "namespace": "indices._types" }, "properties": [ { - "description": "The connection mode for the remote cluster.", - "name": "mode", + "name": "type", "required": true, "type": { "kind": "literal_value", - "value": "sniff" - } - }, - { - "description": "If it is `true`, there is at least one open connection to the remote cluster.\nIf it is `false`, it means that the cluster no longer has an open connection to the remote cluster.\nIt does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost.", - "name": "connected", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "value": "BM25" } }, { - "description": "The maximum number of connections maintained for the remote cluster when sniff mode is configured.", - "name": "max_connections_per_cluster", - "required": true, + "name": "b", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "description": "The number of connected nodes in the remote cluster when sniff mode is configured.", - "name": "num_nodes_connected", - "required": true, + "name": "discount_overlaps", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The initial connect timeout for remote cluster connections.", - "name": "initial_connect_timeout", - "required": true, + "name": "k1", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "double", "namespace": "_types" } } - }, - { - "description": "If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster.", - "extDocId": "modules-cross-cluster-optional", - "name": "skip_unavailable", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The initial seed transport addresses of the remote cluster when sniff mode is configured.", - "name": "seeds", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } } ], - "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L32-L56" + "specLocation": "indices/_types/IndexSettings.ts#L196-L201" }, { "kind": "interface", "name": { - "name": "ClusterRemoteProxyInfo", - "namespace": "cluster.remote_info" + "name": "SettingsSimilarityBoolean", + "namespace": "indices._types" }, "properties": [ { - "description": "The connection mode for the remote cluster.", - "name": "mode", + "name": "type", "required": true, "type": { "kind": "literal_value", - "value": "proxy" + "value": "boolean" } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L192-L194" + }, + { + "kind": "interface", + "name": { + "name": "SettingsSimilarityDfi", + "namespace": "indices._types" + }, + "properties": [ { - "description": "If it is `true`, there is at least one open connection to the remote cluster.\nIf it is `false`, it means that the cluster no longer has an open connection to the remote cluster.\nIt does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost.", - "name": "connected", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "DFI" } }, { - "description": "The initial connect timeout for remote cluster connections.", - "name": "initial_connect_timeout", + "name": "independence_measure", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "DFIIndependenceMeasure", "namespace": "_types" } } - }, - { - "description": "If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster.", - "extDocId": "modules-cross-cluster-optional", - "name": "skip_unavailable", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L203-L206" + }, + { + "kind": "interface", + "name": { + "name": "SettingsSimilarityDfr", + "namespace": "indices._types" + }, + "properties": [ { - "description": "The address for remote connections when proxy mode is configured.", - "name": "proxy_address", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "DFR" } }, { - "name": "server_name", + "name": "after_effect", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DFRAfterEffect", + "namespace": "_types" } } }, { - "description": "The number of open socket connections to the remote cluster when proxy mode is configured.", - "name": "num_proxy_sockets_connected", + "name": "basic_model", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "DFRBasicModel", "namespace": "_types" } } }, { - "description": "The maximum number of socket connections to the remote cluster when proxy mode is configured.", - "name": "max_proxy_socket_connections", + "name": "normalization", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Normalization", "namespace": "_types" } } - }, - { - "description": "This field is present and has a value of `::es_redacted::` only when the remote cluster is configured with the API key based model. Otherwise, the field is not present.", - "name": "cluster_credentials", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } } ], - "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L58-L83" - }, - { - "kind": "type_alias", - "name": { - "name": "ConnectorConfiguration", - "namespace": "connector._types" - }, - "specLocation": "connector/_types/Connector.ts#L101-L104", - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ConnectorConfigProperties", - "namespace": "connector._types" - } - } - } + "specLocation": "indices/_types/IndexSettings.ts#L208-L213" }, { "kind": "interface", "name": { - "name": "ConnectorConfigProperties", - "namespace": "connector._types" + "name": "SettingsSimilarityIb", + "namespace": "indices._types" }, "properties": [ { - "name": "category", - "required": false, + "name": "type", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "literal_value", + "value": "IB" } }, { - "name": "default_value", + "name": "distribution", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ScalarValue", + "name": "IBDistribution", "namespace": "_types" } } }, { - "name": "depends_on", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Dependency", - "namespace": "connector._types" - } - } - } - }, - { - "name": "display", + "name": "lambda", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DisplayType", - "namespace": "connector._types" + "name": "IBLambda", + "namespace": "_types" } } }, { - "name": "label", + "name": "normalization", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Normalization", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L215-L220" + }, + { + "kind": "interface", + "name": { + "name": "SettingsSimilarityLmd", + "namespace": "indices._types" + }, + "properties": [ { - "name": "options", + "name": "type", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SelectOption", - "namespace": "connector._types" - } - } + "kind": "literal_value", + "value": "LMDirichlet" } }, { - "name": "order", + "name": "mu", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } - }, - { - "name": "placeholder", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "required", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L222-L225" + }, + { + "kind": "interface", + "name": { + "name": "SettingsSimilarityLmj", + "namespace": "indices._types" + }, + "properties": [ { - "name": "sensitive", + "name": "type", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "tooltip", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "literal_value", + "value": "LMJelinekMercer" } }, { - "name": "type", + "name": "lambda", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ConnectorFieldType", - "namespace": "connector._types" - } - } - }, - { - "name": "ui_restrictions", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "validations", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Validation", - "namespace": "connector._types" - } + "name": "double", + "namespace": "_types" } } - }, - { - "name": "value", - "required": true, - "type": { - "kind": "user_defined_value" - } } ], - "specLocation": "connector/_types/Connector.ts#L83-L99" + "specLocation": "indices/_types/IndexSettings.ts#L227-L230" }, { "kind": "interface", "name": { - "name": "Dependency", - "namespace": "connector._types" + "name": "SettingsSimilarityScripted", + "namespace": "indices._types" }, "properties": [ { - "name": "field", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "scripted" + } + }, + { + "name": "script", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Script", + "namespace": "_types" } } }, { - "name": "value", - "required": true, + "name": "weight_script", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ScalarValue", + "name": "Script", "namespace": "_types" } } } ], - "specLocation": "connector/_types/Connector.ts#L30-L33" + "specLocation": "indices/_types/IndexSettings.ts#L232-L236" }, { "kind": "enum", "members": [ { - "name": "textbox" + "name": "disabled" }, { - "name": "textarea" + "name": "stored" }, { - "name": "numeric" + "name": "synthetic" + } + ], + "name": { + "name": "SourceMode", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/IndexSettings.ts#L509-L513" + }, + { + "isOpen": true, + "kind": "enum", + "members": [ + { + "description": "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.", + "name": "fs" }, { - "name": "toggle" + "description": "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.", + "name": "niofs" }, { - "name": "dropdown" + "description": "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.", + "name": "mmapfs" + }, + { + "description": "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.", + "name": "hybridfs" } ], "name": { - "name": "DisplayType", - "namespace": "connector._types" + "name": "StorageType", + "namespace": "indices._types" }, - "specLocation": "connector/_types/Connector.ts#L35-L41" + "specLocation": "indices/_types/IndexSettings.ts#L545-L573" }, { - "kind": "interface", - "name": { - "name": "SelectOption", - "namespace": "connector._types" - }, - "properties": [ + "kind": "enum", + "members": [ { - "name": "label", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "aliases": [ + "REQUEST" + ], + "description": "(default) fsync and commit after every request. In the event of hardware failure, all acknowledged writes\nwill already have been committed to disk.", + "name": "request" }, { - "name": "value", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ScalarValue", - "namespace": "_types" - } - } + "aliases": [ + "ASYNC" + ], + "description": "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.", + "name": "async" } ], - "specLocation": "connector/_types/Connector.ts#L25-L28" + "name": { + "name": "TranslogDurability", + "namespace": "indices._types" + }, + "specLocation": "indices/_types/IndexSettings.ts#L379-L394" }, { "kind": "enum", "members": [ { - "name": "str" + "description": "Disable metadata changes, such as closing the index.", + "name": "metadata" }, { - "name": "int" + "description": "Disable read operations.", + "name": "read" }, { - "name": "list" + "description": "Disable write operations and metadata changes.", + "name": "read_only" }, { - "name": "bool" + "description": "Disable write operations. However, metadata changes are still allowed.", + "name": "write" } ], "name": { - "name": "ConnectorFieldType", - "namespace": "connector._types" + "name": "IndicesBlockOptions", + "namespace": "indices.add_block" }, - "specLocation": "connector/_types/Connector.ts#L43-L48" + "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L91-L100" }, { "kind": "type_alias", "name": { - "name": "Validation", - "namespace": "connector._types" + "name": "TextToAnalyze", + "namespace": "indices.analyze" }, - "specLocation": "connector/_types/Connector.ts#L50-L56", + "specLocation": "indices/analyze/types.ts#L69-L69", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "LessThanValidation", - "namespace": "connector._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GreaterThanValidation", - "namespace": "connector._types" + "name": "string", + "namespace": "_builtins" } }, { - "kind": "instance_of", - "type": { - "name": "ListTypeValidation", - "namespace": "connector._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - }, + } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "name": "aliases" + }, + { + "name": "mappings" + }, + { + "name": "settings" + } + ], + "name": { + "name": "Feature", + "namespace": "indices.get" + }, + "specLocation": "indices/get/IndicesGetRequest.ts#L98-L102" + }, + { + "kind": "type_alias", + "name": { + "name": "Features", + "namespace": "indices.get" + }, + "specLocation": "indices/get/IndicesGetRequest.ts#L103-L103", + "type": { + "items": [ { "kind": "instance_of", "type": { - "name": "IncludedInValidation", - "namespace": "connector._types" + "name": "Feature", + "namespace": "indices.get" } }, { - "kind": "instance_of", - "type": { - "name": "RegexValidation", - "namespace": "connector._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Feature", + "namespace": "indices.get" + } } } ], "kind": "union_of" - }, - "variants": { - "kind": "internal_tag", - "tag": "type" } }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "upgrade" + } + ], "name": { - "name": "LessThanValidation", - "namespace": "connector._types" + "name": "ModeEnum", + "namespace": "indices.migrate_reindex" }, - "properties": [ + "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L54-L56" + }, + { + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "less_than" - } + "name": "primary" }, { - "name": "constraint", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "name": "replica" + }, + { + "name": "unused" } ], - "specLocation": "connector/_types/Connector.ts#L58-L61" - }, - { - "kind": "interface", "name": { - "name": "GreaterThanValidation", - "namespace": "connector._types" + "name": "ShardStoreAllocation", + "namespace": "indices.shard_stores" }, - "properties": [ + "specLocation": "indices/shard_stores/types.ts#L47-L51" + }, + { + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "greater_than" - } + "description": "The primary shard and all replica shards are assigned.", + "name": "green" }, { - "name": "constraint", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "description": "One or more replica shards are unassigned.", + "name": "yellow" + }, + { + "description": "The primary shard is unassigned.", + "name": "red" + }, + { + "description": "Return all shards, regardless of health status.", + "name": "all" } ], - "specLocation": "connector/_types/Connector.ts#L63-L66" - }, - { - "kind": "interface", "name": { - "name": "ListTypeValidation", - "namespace": "connector._types" + "name": "ShardStoreStatus", + "namespace": "indices.shard_stores" }, - "properties": [ + "specLocation": "indices/shard_stores/types.ts#L62-L71" + }, + { + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "list_type" - } + "name": "open" }, { - "name": "constraint", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "close" } ], - "specLocation": "connector/_types/Connector.ts#L68-L71" - }, - { - "kind": "interface", "name": { - "name": "IncludedInValidation", - "namespace": "connector._types" + "name": "IndexMetadataState", + "namespace": "indices.stats" }, - "properties": [ + "specLocation": "indices/stats/types.ts#L225-L232" + }, + { + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "included_in" - } + "name": "UNASSIGNED" }, { - "name": "constraint", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ScalarValue", - "namespace": "_types" - } - } - } + "name": "INITIALIZING" + }, + { + "name": "STARTED" + }, + { + "name": "RELOCATING" } ], - "specLocation": "connector/_types/Connector.ts#L73-L76" + "name": { + "name": "ShardRoutingState", + "namespace": "indices.stats" + }, + "specLocation": "indices/stats/types.ts#L169-L174" }, { - "kind": "interface", + "description": "Text Embedding results containing bytes are represented as Dense\nVectors of bytes.", + "kind": "type_alias", "name": { - "name": "RegexValidation", - "namespace": "connector._types" + "name": "DenseByteVector", + "namespace": "inference._types" }, - "properties": [ - { - "name": "type", - "required": true, + "specLocation": "inference/_types/Results.ts#L47-L51", + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", "type": { - "kind": "literal_value", - "value": "regex" + "name": "byte", + "namespace": "_types" } - }, - { - "name": "constraint", - "required": true, + } + } + }, + { + "description": "Text Embedding results are represented as Dense Vectors\nof floats.", + "kind": "type_alias", + "name": { + "name": "DenseVector", + "namespace": "inference._types" + }, + "specLocation": "inference/_types/Results.ts#L30-L34", + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "float", + "namespace": "_types" } } - ], - "specLocation": "connector/_types/Connector.ts#L78-L81" + } }, { "kind": "type_alias", "name": { - "name": "ConnectorCustomScheduling", - "namespace": "connector._types" + "name": "ServiceSettings", + "namespace": "inference._types" }, - "specLocation": "connector/_types/Connector.ts#L128-L128", + "specLocation": "inference/_types/Services.ts#L91-L91", + "type": { + "kind": "user_defined_value" + } + }, + { + "description": "Sparse Embedding tokens are represented as a dictionary\nof string to double.", + "kind": "type_alias", + "name": { + "name": "SparseVector", + "namespace": "inference._types" + }, + "specLocation": "inference/_types/Results.ts#L24-L28", "type": { "key": { "kind": "instance_of", @@ -97678,1251 +101651,1308 @@ "value": { "kind": "instance_of", "type": { - "name": "CustomScheduling", - "namespace": "connector._types" + "name": "float", + "namespace": "_types" } } } }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "CustomScheduling", - "namespace": "connector._types" + "name": "TaskSettings", + "namespace": "inference._types" }, - "properties": [ + "specLocation": "inference/_types/Services.ts#L93-L93", + "type": { + "kind": "user_defined_value" + } + }, + { + "kind": "enum", + "members": [ { - "name": "configuration_overrides", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "CustomSchedulingConfigurationOverrides", - "namespace": "connector._types" - } - } + "name": "sparse_embedding" }, { - "name": "enabled", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "text_embedding" }, { - "name": "interval", - "required": true, - "type": { + "name": "rerank" + }, + { + "name": "completion" + }, + { + "name": "chat_completion" + } + ], + "name": { + "name": "TaskType", + "namespace": "inference._types" + }, + "specLocation": "inference/_types/TaskType.ts#L20-L29" + }, + { + "codegenNames": [ + "string", + "object" + ], + "kind": "type_alias", + "name": { + "name": "CompletionToolType", + "namespace": "inference.chat_completion_unified" + }, + "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L54-L57", + "type": { + "items": [ + { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } + }, + { + "kind": "instance_of", + "type": { + "name": "CompletionToolChoice", + "namespace": "inference.chat_completion_unified" + } } - }, + ], + "kind": "union_of" + } + }, + { + "description": "Controls which tool is called by the model.", + "kind": "interface", + "name": { + "name": "CompletionToolChoice", + "namespace": "inference.chat_completion_unified" + }, + "properties": [ { - "name": "last_synced", - "required": false, + "description": "The type of the tool.", + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "name", + "description": "The tool choice function.", + "name": "function", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CompletionToolChoiceFunction", + "namespace": "inference.chat_completion_unified" } } } ], - "specLocation": "connector/_types/Connector.ts#L120-L126" + "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L143-L155" }, { + "description": "The tool choice function.", "kind": "interface", "name": { - "name": "CustomSchedulingConfigurationOverrides", - "namespace": "connector._types" + "name": "CompletionToolChoiceFunction", + "namespace": "inference.chat_completion_unified" }, "properties": [ { - "name": "max_crawl_depth", - "required": false, + "description": "The name of the function to call.", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, - { - "name": "sitemap_discovery_disabled", - "required": false, - "type": { + } + ], + "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L132-L141" + }, + { + "codegenNames": [ + "string", + "object" + ], + "kind": "type_alias", + "name": { + "name": "MessageContent", + "namespace": "inference.chat_completion_unified" + }, + "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L105-L108", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } - } - }, - { - "name": "domain_allowlist", - "required": false, - "type": { + }, + { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ContentObject", + "namespace": "inference.chat_completion_unified" } } } - }, + ], + "kind": "union_of" + } + }, + { + "description": "An object style representation of a single portion of a conversation.", + "kind": "interface", + "name": { + "name": "ContentObject", + "namespace": "inference.chat_completion_unified" + }, + "properties": [ { - "name": "sitemap_urls", - "required": false, + "description": "The text content.", + "name": "text", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "seed_urls", - "required": false, + "description": "The type of content.", + "name": "type", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "connector/_types/Connector.ts#L112-L118" + "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L59-L71" }, { "kind": "enum", "members": [ { - "name": "created" +<<<<<<< HEAD +======= + "name": "completion" }, { - "name": "needs_configuration" + "name": "rerank" }, { - "name": "configured" + "name": "space_embedding" }, { - "name": "connected" + "name": "text_embedding" + } + ], + "name": { + "name": "AlibabaCloudTaskType", + "namespace": "inference.put_alibabacloud" + }, + "specLocation": "inference/put_alibabacloud/PutAlibabaCloudRequest.ts#L82-L87" + }, + { + "kind": "enum", + "members": [ + { + "name": "alibabacloud-ai-search" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_alibabacloud" + }, + "specLocation": "inference/put_alibabacloud/PutAlibabaCloudRequest.ts#L89-L91" + }, + { + "kind": "enum", + "members": [ + { + "name": "completion" }, { - "name": "error" + "name": "text_embedding" } ], "name": { - "name": "ConnectorStatus", - "namespace": "connector._types" + "name": "AmazonBedrockTaskType", + "namespace": "inference.put_amazonbedrock" }, - "specLocation": "connector/_types/Connector.ts#L130-L136" + "specLocation": "inference/put_amazonbedrock/PutAmazonBedrockRequest.ts#L86-L89" }, { "kind": "enum", "members": [ { - "name": "exclude" + "name": "amazonbedrock" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_amazonbedrock" + }, + "specLocation": "inference/put_amazonbedrock/PutAmazonBedrockRequest.ts#L91-L93" + }, + { + "kind": "enum", + "members": [ + { + "name": "completion" + } + ], + "name": { + "name": "AnthropicTaskType", + "namespace": "inference.put_anthropic" + }, + "specLocation": "inference/put_anthropic/PutAnthropicRequest.ts#L84-L86" + }, + { + "kind": "enum", + "members": [ + { + "name": "anthropic" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_anthropic" + }, + "specLocation": "inference/put_anthropic/PutAnthropicRequest.ts#L88-L90" + }, + { + "kind": "enum", + "members": [ + { + "name": "completion" }, { - "name": "include" + "name": "text_embedding" } ], "name": { - "name": "FilteringPolicy", - "namespace": "connector._types" + "name": "AzureAiStudioTaskType", + "namespace": "inference.put_azureaistudio" }, - "specLocation": "connector/_types/Connector.ts#L155-L158" + "specLocation": "inference/put_azureaistudio/PutAzureAiStudioRequest.ts#L83-L86" }, { "kind": "enum", "members": [ { - "name": "contains" + "name": "azureaistudio" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_azureaistudio" + }, + "specLocation": "inference/put_azureaistudio/PutAzureAiStudioRequest.ts#L88-L90" + }, + { + "kind": "enum", + "members": [ + { + "name": "completion" }, { - "name": "ends_with" + "name": "text_embedding" + } + ], + "name": { + "name": "AzureOpenAITaskType", + "namespace": "inference.put_azureopenai" + }, + "specLocation": "inference/put_azureopenai/PutAzureOpenAiRequest.ts#L90-L93" + }, + { + "kind": "enum", + "members": [ + { + "name": "azureopenai" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_azureopenai" + }, + "specLocation": "inference/put_azureopenai/PutAzureOpenAiRequest.ts#L95-L97" + }, + { + "kind": "enum", + "members": [ + { + "name": "completion" }, { - "name": "equals" + "name": "rerank" }, { - "name": "regex" + "name": "text_embedding" + } + ], + "name": { + "name": "CohereTaskType", + "namespace": "inference.put_cohere" + }, + "specLocation": "inference/put_cohere/PutCohereRequest.ts#L84-L88" + }, + { + "kind": "enum", + "members": [ + { + "name": "byte" }, { - "name": "starts_with" + "name": "float" }, { - "codegenName": "greater_than", - "name": ">" + "name": "int8" + } + ], + "name": { + "name": "EmbeddingType", + "namespace": "inference.put_cohere" + }, + "specLocation": "inference/put_cohere/PutCohereRequest.ts#L94-L98" + }, + { + "kind": "enum", + "members": [ + { + "name": "classification" }, { - "codegenName": "less_than", - "name": "<" + "name": "clustering" + }, + { + "name": "ingest" + }, + { + "name": "search" } ], "name": { - "name": "FilteringRuleRule", - "namespace": "connector._types" + "name": "InputType", + "namespace": "inference.put_cohere" }, - "specLocation": "connector/_types/Connector.ts#L160-L168" + "specLocation": "inference/put_cohere/PutCohereRequest.ts#L100-L105" }, { "kind": "enum", "members": [ { - "name": "edited" + "name": "cohere" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_cohere" + }, + "specLocation": "inference/put_cohere/PutCohereRequest.ts#L90-L92" + }, + { + "kind": "enum", + "members": [ + { + "name": "cosine" }, { - "name": "invalid" + "name": "dot_product" }, { - "name": "valid" + "name": "l2_norm" } ], "name": { - "name": "FilteringValidationState", - "namespace": "connector._types" + "name": "SimilarityType", + "namespace": "inference.put_cohere" }, - "specLocation": "connector/_types/Connector.ts#L186-L190" + "specLocation": "inference/put_cohere/PutCohereRequest.ts#L107-L111" }, { "kind": "enum", "members": [ { - "name": "on_demand" + "name": "END" }, { - "name": "scheduled" + "name": "NONE" + }, + { + "name": "START" } ], "name": { - "name": "SyncJobTriggerMethod", - "namespace": "connector._types" + "name": "TruncateType", + "namespace": "inference.put_cohere" }, - "specLocation": "connector/_types/SyncJob.ts#L48-L51" + "specLocation": "inference/put_cohere/PutCohereRequest.ts#L113-L117" }, { "kind": "enum", "members": [ { - "name": "full" + "name": "chat_completion" + } + ], + "name": { + "name": "EisTaskType", + "namespace": "inference.put_eis" + }, + "specLocation": "inference/put_eis/PutEisRequest.ts#L64-L66" + }, + { + "kind": "enum", + "members": [ + { + "name": "elastic" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_eis" + }, + "specLocation": "inference/put_eis/PutEisRequest.ts#L68-L70" + }, + { + "kind": "enum", + "members": [ + { + "name": "rerank" }, { - "name": "incremental" + "name": "sparse_embedding" }, { - "name": "access_control" + "name": "text_embedding" } ], "name": { - "name": "SyncJobType", - "namespace": "connector._types" + "name": "ElasticsearchTaskType", + "namespace": "inference.put_elasticsearch" }, - "specLocation": "connector/_types/SyncJob.ts#L42-L46" + "specLocation": "inference/put_elasticsearch/PutElasticsearchRequest.ts#L88-L92" }, { "kind": "enum", "members": [ { - "name": "canceling" + "name": "elasticsearch" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_elasticsearch" + }, + "specLocation": "inference/put_elasticsearch/PutElasticsearchRequest.ts#L94-L96" + }, + { + "kind": "enum", + "members": [ + { + "name": "sparse_embedding" + } + ], + "name": { + "name": "ElserTaskType", + "namespace": "inference.put_elser" + }, + "specLocation": "inference/put_elser/PutElserRequest.ts#L84-L86" + }, + { + "kind": "enum", + "members": [ + { + "name": "elser" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_elser" + }, + "specLocation": "inference/put_elser/PutElserRequest.ts#L88-L90" + }, + { + "kind": "enum", + "members": [ + { + "name": "completion" }, { - "name": "canceled" + "name": "text_embedding" + } + ], + "name": { + "name": "GoogleAiStudioTaskType", + "namespace": "inference.put_googleaistudio" + }, + "specLocation": "inference/put_googleaistudio/PutGoogleAiStudioRequest.ts#L77-L80" + }, + { + "kind": "enum", + "members": [ + { + "name": "googleaistudio" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_googleaistudio" + }, + "specLocation": "inference/put_googleaistudio/PutGoogleAiStudioRequest.ts#L82-L84" + }, + { + "kind": "enum", + "members": [ + { + "name": "rerank" }, { - "name": "completed" + "name": "text_embedding" + } + ], + "name": { + "name": "GoogleVertexAITaskType", + "namespace": "inference.put_googlevertexai" + }, + "specLocation": "inference/put_googlevertexai/PutGoogleVertexAiRequest.ts#L83-L86" + }, + { + "kind": "enum", + "members": [ + { + "name": "googlevertexai" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_googlevertexai" + }, + "specLocation": "inference/put_googlevertexai/PutGoogleVertexAiRequest.ts#L88-L90" + }, + { + "kind": "enum", + "members": [ + { +>>>>>>> ef980f023 (Add Alibaba Cloud inference API (#4021)) + "name": "text_embedding" + } + ], + "name": { + "name": "HuggingFaceTaskType", + "namespace": "inference.put_hugging_face" + }, + "specLocation": "inference/put_hugging_face/PutHuggingFaceRequest.ts#L91-L93" + }, + { + "kind": "enum", + "members": [ + { + "name": "hugging_face" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_hugging_face" + }, + "specLocation": "inference/put_hugging_face/PutHuggingFaceRequest.ts#L95-L97" + }, + { + "kind": "enum", + "members": [ + { + "name": "chat_completion" }, { - "name": "error" + "name": "completion" }, { - "name": "in_progress" + "name": "text_embedding" + } + ], + "name": { + "name": "OpenAITaskType", + "namespace": "inference.put_openai" + }, + "specLocation": "inference/put_openai/PutOpenAiRequest.ts#L84-L88" + }, + { + "kind": "enum", + "members": [ + { + "name": "openai" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_openai" + }, + "specLocation": "inference/put_openai/PutOpenAiRequest.ts#L90-L92" + }, + { + "kind": "enum", + "members": [ + { + "name": "watsonxai" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_watsonx" + }, + "specLocation": "inference/put_watsonx/PutWatsonxRequest.ts#L76-L78" + }, + { + "kind": "enum", + "members": [ + { + "name": "text_embedding" + } + ], + "name": { + "name": "WatsonxTaskType", + "namespace": "inference.put_watsonx" + }, + "specLocation": "inference/put_watsonx/PutWatsonxRequest.ts#L72-L74" + }, + { + "kind": "enum", + "members": [ + { + "name": "integer" }, { - "name": "pending" + "name": "long" + }, + { + "name": "double" + }, + { + "name": "float" + }, + { + "name": "boolean" + }, + { + "name": "ip" + }, + { + "name": "string" + }, + { + "name": "auto" + } + ], + "name": { + "name": "ConvertType", + "namespace": "ingest._types" + }, + "specLocation": "ingest/_types/Processors.ts#L662-L671" + }, + { + "kind": "enum", + "members": [ + { + "codegenName": "md5", + "name": "MD5" + }, + { + "codegenName": "sha1", + "name": "SHA-1" + }, + { + "codegenName": "sha256", + "name": "SHA-256" + }, + { + "codegenName": "sha512", + "name": "SHA-512" }, { - "name": "suspended" + "codegenName": "murmurHash3", + "name": "MurmurHash3" } ], "name": { - "name": "SyncStatus", - "namespace": "connector._types" + "name": "FingerprintDigest", + "namespace": "ingest._types" }, - "specLocation": "connector/_types/Connector.ts#L138-L146" + "specLocation": "ingest/_types/Processors.ts#L897-L903" }, { "kind": "enum", "members": [ { - "name": "geo_match" - }, - { - "name": "match" + "name": "geojson" }, { - "name": "range" + "name": "wkt" } ], "name": { - "name": "PolicyType", - "namespace": "enrich._types" + "name": "GeoGridTargetFormat", + "namespace": "ingest._types" }, - "specLocation": "enrich/_types/Policy.ts#L28-L32" + "specLocation": "ingest/_types/Processors.ts#L438-L441" }, { "kind": "enum", "members": [ { - "name": "SCHEDULED" - }, - { - "name": "RUNNING" + "name": "geotile" }, { - "name": "COMPLETE" + "name": "geohex" }, { - "name": "FAILED" + "name": "geohash" } ], "name": { - "name": "EnrichPolicyPhase", - "namespace": "enrich.execute_policy" + "name": "GeoGridTileType", + "namespace": "ingest._types" }, - "specLocation": "enrich/execute_policy/types.ts#L24-L29" + "specLocation": "ingest/_types/Processors.ts#L432-L436" }, { "kind": "enum", "members": [ { - "description": "Return the most recent matches, similar to the Unix tail command.", - "name": "tail" + "description": "Root fields that conflict with fields from the parsed JSON will be overridden.", + "name": "replace" }, { - "description": "Return the earliest matches, similar to the Unix head command.", - "name": "head" + "description": "Conflicting fields will be merged.", + "name": "merge" } ], "name": { - "name": "ResultPosition", - "namespace": "eql.search" + "name": "JsonProcessorConflictStrategy", + "namespace": "ingest._types" }, - "specLocation": "eql/search/types.ts#L20-L32" + "specLocation": "ingest/_types/Processors.ts#L1152-L1157" }, { "kind": "enum", "members": [ { - "name": "csv" - }, - { - "name": "json" + "name": "geo_shape" }, { - "name": "tsv" - }, + "name": "shape" + } + ], + "name": { + "name": "ShapeType", + "namespace": "ingest._types" + }, + "specLocation": "ingest/_types/Processors.ts#L1474-L1477" + }, + { + "kind": "enum", + "members": [ { - "name": "txt" + "name": "name" }, { - "name": "yaml" + "name": "os" }, { - "name": "cbor" + "name": "device" }, { - "name": "smile" + "name": "original" }, { - "name": "arrow" + "name": "version" } ], "name": { - "name": "EsqlFormat", - "namespace": "esql._types" - }, - "specLocation": "esql/_types/QueryParameters.ts#L20-L29" - }, - { - "kind": "type_alias", - "name": { - "name": "TableValuesIntegerValue", - "namespace": "esql._types" - }, - "specLocation": "esql/_types/TableValuesContainer.ts#L30-L30", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "TableValuesKeywordValue", - "namespace": "esql._types" - }, - "specLocation": "esql/_types/TableValuesContainer.ts#L31-L31", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "TableValuesLongDouble", - "namespace": "esql._types" - }, - "specLocation": "esql/_types/TableValuesContainer.ts#L33-L33", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "type_alias", - "name": { - "name": "TableValuesLongValue", - "namespace": "esql._types" + "name": "UserAgentProperty", + "namespace": "ingest._types" }, - "specLocation": "esql/_types/TableValuesContainer.ts#L32-L32", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" - } + "specLocation": "ingest/_types/Processors.ts#L548-L554" }, { - "kind": "type_alias", - "name": { - "name": "Checkpoint", - "namespace": "fleet._types" - }, - "specLocation": "fleet/_types/Checkpoints.ts#L22-L22", - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "enum", + "members": [ + { + "name": "active" + }, + { + "name": "valid" + }, + { + "name": "invalid" + }, + { + "name": "expired" } - } - }, - { - "kind": "type_alias", + ], "name": { - "name": "LifecycleExplain", - "namespace": "ilm.explain_lifecycle" - }, - "specLocation": "ilm/explain_lifecycle/types.ts#L64-L67", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "LifecycleExplainManaged", - "namespace": "ilm.explain_lifecycle" - } - }, - { - "kind": "instance_of", - "type": { - "name": "LifecycleExplainUnmanaged", - "namespace": "ilm.explain_lifecycle" - } - } - ], - "kind": "union_of" + "name": "LicenseStatus", + "namespace": "license._types" }, - "variants": { - "kind": "internal_tag", - "tag": "managed" - } + "specLocation": "license/_types/License.ts#L35-L40" }, { - "kind": "interface", - "name": { - "name": "LifecycleExplainManaged", - "namespace": "ilm.explain_lifecycle" - }, - "properties": [ + "kind": "enum", + "members": [ { - "name": "action", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } + "name": "missing" }, { - "name": "action_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } + "name": "trial" }, { - "name": "action_time_millis", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } + "name": "basic" }, { - "name": "age", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "name": "standard" }, { - "name": "failed_step", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } + "name": "dev" }, { - "name": "failed_step_retry_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "silver" }, { - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } + "name": "gold" }, { - "name": "index_creation_date", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } + "name": "platinum" }, { - "name": "index_creation_date_millis", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - }, + "name": "enterprise" + } + ], + "name": { + "name": "LicenseType", + "namespace": "license._types" + }, + "specLocation": "license/_types/License.ts#L23-L33" + }, + { + "kind": "enum", + "members": [ { - "name": "is_auto_retryable_error", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "none" }, { - "name": "lifecycle_date", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } + "name": "info" }, { - "name": "lifecycle_date_millis", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } + "description": "You can upgrade directly, but you are using deprecated functionality which will not be available or behave differently in the next major version.", + "name": "warning" }, { - "name": "managed", - "required": true, - "type": { - "kind": "literal_value", - "value": true - } - }, + "description": "You cannot upgrade without fixing this problem.", + "name": "critical" + } + ], + "name": { + "name": "DeprecationLevel", + "namespace": "migration.deprecations" + }, + "specLocation": "migration/deprecations/types.ts#L23-L30" + }, + { + "kind": "enum", + "members": [ { - "name": "phase", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } + "name": "NO_MIGRATION_NEEDED" }, { - "name": "phase_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } + "name": "MIGRATION_NEEDED" }, { - "name": "phase_time_millis", - "required": false, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } + "name": "IN_PROGRESS" }, { - "name": "policy", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, + "name": "ERROR" + } + ], + "name": { + "name": "MigrationStatus", + "namespace": "migration.get_feature_upgrade_status" + }, + "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts#L30-L35" + }, + { + "kind": "enum", + "members": [ { - "name": "previous_step_info", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } + "name": "actual" }, { - "name": "repository_name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "typical" }, { - "name": "snapshot_name", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "diff_from_typical" }, { - "name": "shrink_index_name", - "required": false, - "type": { + "name": "time" + } + ], + "name": { + "name": "AppliesTo", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Rule.ts#L67-L72" + }, + { + "codegenNames": [ + "name", + "definition" + ], + "kind": "type_alias", + "name": { + "name": "CategorizationAnalyzer", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Analysis.ts#L181-L182", + "type": { + "items": [ + { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - } - }, - { - "name": "step", - "required": false, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "CategorizationAnalyzerDefinition", + "namespace": "ml._types" } } - }, + ], + "kind": "union_of" + } + }, + { + "kind": "interface", + "name": { + "name": "CategorizationAnalyzerDefinition", + "namespace": "ml._types" + }, + "properties": [ { - "name": "step_info", + "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.", + "name": "char_filter", "required": false, "type": { - "key": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CharFilter", + "namespace": "_types.analysis" } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "step_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" } } }, { - "name": "step_time_millis", + "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.", + "name": "filter", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TokenFilter", + "namespace": "_types.analysis" } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" } } }, { - "name": "phase_execution", + "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`.", + "extDocId": "analysis-tokenizers", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", + "name": "tokenizer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "LifecycleExplainPhaseExecution", - "namespace": "ilm.explain_lifecycle" + "name": "Tokenizer", + "namespace": "_types.analysis" } } + } + ], + "specLocation": "ml/_types/Analysis.ts#L184-L198" + }, + { + "kind": "enum", + "members": [ + { + "name": "ok" }, { - "name": "time_since_index_creation", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "name": "warn" } ], - "specLocation": "ilm/explain_lifecycle/types.ts#L27-L57" + "name": { + "name": "CategorizationStatus", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Model.ts#L84-L87" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "auto" + }, + { + "name": "manual" + }, + { + "name": "off" + } + ], "name": { - "name": "LifecycleExplainPhaseExecution", - "namespace": "ilm.explain_lifecycle" + "name": "ChunkingMode", + "namespace": "ml._types" }, - "properties": [ + "specLocation": "ml/_types/Datafeed.ts#L245-L249" + }, + { + "kind": "enum", + "members": [ { - "name": "phase_definition", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Phase", - "namespace": "ilm._types" - } - } + "name": "gt" }, { - "name": "policy", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } + "name": "gte" }, { - "name": "version", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } + "name": "lt" }, { - "name": "modified_date_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } + "name": "lte" } ], - "specLocation": "ilm/explain_lifecycle/types.ts#L69-L74" + "name": { + "name": "ConditionOperator", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Rule.ts#L74-L79" }, { - "kind": "interface", + "description": "Custom metadata about the job", + "kind": "type_alias", "name": { - "name": "Phase", - "namespace": "ilm._types" + "name": "CustomSettings", + "namespace": "ml._types" }, - "properties": [ + "specLocation": "ml/_types/Settings.ts#L22-L27", + "type": { + "kind": "user_defined_value" + } + }, + { + "kind": "enum", + "members": [ { - "name": "actions", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Actions", - "namespace": "ilm._types" - } - } + "name": "started" }, { - "name": "min_age", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "name": "stopped" + }, + { + "name": "starting" + }, + { + "name": "stopping" } ], - "specLocation": "ilm/_types/Phase.ts#L26-L29" - }, - { - "kind": "interface", "name": { - "name": "Actions", - "namespace": "ilm._types" + "name": "DatafeedState", + "namespace": "ml._types" }, - "properties": [ + "specLocation": "ml/_types/Datafeed.ts#L136-L141" + }, + { + "kind": "enum", + "members": [ { - "description": "Phases allowed: warm, cold.", - "name": "allocate", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "AllocateAction", - "namespace": "ilm._types" - } - } + "name": "started" }, { - "description": "Phases allowed: delete.", - "name": "delete", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DeleteAction", - "namespace": "ilm._types" - } - } + "name": "stopped" }, { - "description": "Phases allowed: hot, warm, cold.", - "name": "downsample", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DownsampleAction", - "namespace": "ilm._types" - } - } + "name": "starting" }, { - "deprecation": { - "description": "", - "version": "7.0.0" - }, - "description": "The freeze action is a noop in 8.x", - "name": "freeze", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "EmptyObject", - "namespace": "_types" - } - } + "name": "stopping" }, { - "description": "Phases allowed: hot, warm.", - "name": "forcemerge", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ForceMergeAction", - "namespace": "ilm._types" - } - } - }, + "name": "failed" + } + ], + "name": { + "name": "DataframeState", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Dataframe.ts#L20-L26" + }, + { + "kind": "enum", + "members": [ { - "description": "Phases allowed: warm, cold.", - "name": "migrate", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MigrateAction", - "namespace": "ilm._types" - } - } + "description": "The trained model is started on at least one node.", + "name": "started" }, { - "description": "Phases allowed: hot, warm, cold.", - "name": "readonly", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "EmptyObject", - "namespace": "_types" - } - } + "description": "Trained model deployment is starting but it is not yet deployed on any nodes.", + "name": "starting" }, { - "description": "Phases allowed: hot.", - "name": "rollover", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RolloverAction", - "namespace": "ilm._types" - } - } - }, + "description": "Trained model deployment has started on all valid nodes.", + "name": "fully_allocated" + } + ], + "name": { + "name": "DeploymentAllocationState", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/TrainedModel.ts#L330-L343" + }, + { + "kind": "enum", + "members": [ { - "description": "Phases allowed: hot, warm, cold.", - "name": "set_priority", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SetPriorityAction", - "namespace": "ilm._types" - } - } + "description": "The deployment is usable; at least one node has the model allocated.", + "name": "started" }, { - "description": "Phases allowed: hot, cold, frozen.", - "name": "searchable_snapshot", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SearchableSnapshotAction", - "namespace": "ilm._types" - } - } + "description": "The deployment has recently started but is not yet usable; the model is not allocated on any nodes.", + "name": "starting" }, { - "description": "Phases allowed: hot, warm.", - "name": "shrink", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ShrinkAction", - "namespace": "ilm._types" - } - } + "description": "The deployment is preparing to stop and deallocate the model from the relevant nodes.", + "name": "stopping" }, { - "description": "Phases allowed: hot, warm, cold, frozen.", - "name": "unfollow", - "required": false, + "description": "The deployment is on a failed state and must be re-deployed.", + "name": "failed" + } + ], + "name": { + "name": "DeploymentAssignmentState", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/TrainedModel.ts#L345-L362" + }, + { + "kind": "type_alias", + "name": { + "name": "DiscoveryNode", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/DiscoveryNode.ts#L25-L25", + "type": { + "key": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "EmptyObject", - "namespace": "_types" - } + "name": "Id", + "namespace": "_types" } }, - { - "description": "Phases allowed: delete.", - "name": "wait_for_snapshot", - "required": false, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", "type": { - "kind": "instance_of", - "type": { - "name": "WaitForSnapshotAction", - "namespace": "ilm._types" - } + "name": "DiscoveryNodeContent", + "namespace": "ml._types" } } - ], - "specLocation": "ilm/_types/Phase.ts#L39-L93" + } }, { "kind": "interface", "name": { - "name": "AllocateAction", - "namespace": "ilm._types" + "name": "DiscoveryNodeContent", + "namespace": "ml._types" }, "properties": [ { - "name": "number_of_replicas", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Name", "namespace": "_types" } } }, { - "name": "total_shards_per_node", - "required": false, + "name": "ephemeral_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Id", "namespace": "_types" } } }, { - "name": "include", - "required": false, + "name": "transport_address", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "TransportAddress", + "namespace": "_types" } } }, { - "name": "exclude", - "required": false, + "name": "external_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "attributes", + "required": true, "type": { "key": { "kind": "instance_of", @@ -98943,18 +102973,10 @@ } }, { - "name": "require", - "required": false, + "name": "roles", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { @@ -98963,1420 +102985,1565 @@ } } } - } - ], - "specLocation": "ilm/_types/Phase.ts#L133-L139" - }, - { - "kind": "interface", - "name": { - "name": "DeleteAction", - "namespace": "ilm._types" - }, - "properties": [ + }, { - "name": "delete_searchable_snapshot", - "required": false, + "name": "version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } - } - ], - "specLocation": "ilm/_types/Phase.ts#L149-L151" - }, - { - "kind": "interface", - "name": { - "name": "DownsampleAction", - "namespace": "ilm._types" - }, - "properties": [ + }, { - "name": "fixed_interval", + "name": "min_index_version", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DurationLarge", + "name": "integer", "namespace": "_types" } } }, { - "name": "wait_timeout", - "required": false, + "name": "max_index_version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } } ], - "specLocation": "ilm/_types/Phase.ts#L112-L115" + "specLocation": "ml/_types/DiscoveryNode.ts#L27-L37" }, { - "kind": "interface", - "name": { - "name": "ForceMergeAction", - "namespace": "ilm._types" - }, - "properties": [ + "kind": "enum", + "members": [ { - "name": "max_num_segments", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "all" }, { - "name": "index_codec", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "none" + }, + { + "name": "by" + }, + { + "name": "over" } ], - "specLocation": "ilm/_types/Phase.ts#L123-L126" - }, - { - "kind": "interface", "name": { - "name": "MigrateAction", - "namespace": "ilm._types" + "name": "ExcludeFrequent", + "namespace": "ml._types" }, - "properties": [ + "specLocation": "ml/_types/Detector.ts#L145-L150" + }, + { + "kind": "enum", + "members": [ { - "name": "enabled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "include" + }, + { + "name": "exclude" } ], - "specLocation": "ilm/_types/Phase.ts#L141-L143" - }, - { - "kind": "interface", "name": { - "name": "RolloverAction", - "namespace": "ilm._types" + "name": "FilterType", + "namespace": "ml._types" }, - "properties": [ + "specLocation": "ml/_types/Filter.ts#L43-L46" + }, + { + "kind": "enum", + "members": [ { - "name": "max_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } + "description": "Includes the model definition.", + "name": "definition" }, { - "name": "max_primary_shard_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } + "description": "Includes the baseline for feature importance values.", + "name": "feature_importance_baseline" }, { - "name": "max_age", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "description": "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.", + "name": "hyperparameters" }, { - "name": "max_docs", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "description": "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.", + "name": "total_feature_importance" }, { - "name": "max_primary_shard_docs", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "description": "Includes the model definition status.", + "name": "definition_status" + } + ], + "name": { + "name": "Include", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Include.ts#L20-L47" + }, + { + "kind": "enum", + "members": [ + { + "name": "delete" }, { - "name": "min_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } + "name": "reset" }, { - "name": "min_primary_shard_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } + "name": "revert" + } + ], + "name": { + "name": "JobBlockedReason", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Job.ts#L397-L401" + }, + { + "kind": "enum", + "members": [ + { + "description": "The job close action is in progress and has not yet completed. A closing job cannot accept further data.", + "name": "closing" }, { - "name": "min_age", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "description": "The job finished successfully with its model state persisted. The job must be opened before it can accept further data.", + "name": "closed" }, { - "name": "min_docs", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "description": "The job is available to receive and process data.", + "name": "opened" }, { - "name": "min_primary_shard_docs", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } + "description": "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.", + "name": "failed" + }, + { + "description": "The job open action is in progress and has not yet completed.", + "name": "opening" } ], - "specLocation": "ilm/_types/Phase.ts#L99-L110" - }, - { - "kind": "interface", "name": { - "name": "SetPriorityAction", - "namespace": "ilm._types" + "name": "JobState", + "namespace": "ml._types" }, - "properties": [ - { - "name": "priority", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ], - "specLocation": "ilm/_types/Phase.ts#L95-L97" + "specLocation": "ml/_types/Job.ts#L36-L52" }, { - "kind": "interface", - "name": { - "name": "SearchableSnapshotAction", - "namespace": "ilm._types" - }, - "properties": [ + "kind": "enum", + "members": [ { - "name": "snapshot_repository", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "ok" }, { - "name": "force_merge_index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "soft_limit" + }, + { + "name": "hard_limit" } ], - "specLocation": "ilm/_types/Phase.ts#L128-L131" + "name": { + "name": "MemoryStatus", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Model.ts#L89-L93" }, { - "kind": "interface", + "kind": "type_alias", "name": { - "name": "ShrinkAction", - "namespace": "ilm._types" + "name": "PredictedValue", + "namespace": "ml._types" }, - "properties": [ - { - "name": "number_of_shards", - "required": false, - "type": { + "specLocation": "ml/_types/inference.ts#L445-L445", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "integer", + "name": "ScalarValue", "namespace": "_types" } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ScalarValue", + "namespace": "_types" + } + } } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [ + { + "description": "The allocation attempt failed.", + "name": "failed" }, { - "name": "max_primary_shard_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } + "description": "The trained model is allocated and ready to accept inference requests.", + "name": "started" }, { - "name": "allow_write_after_shrink", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "description": "The trained model is attempting to allocate on this node; inference requests are not yet accepted.", + "name": "starting" + }, + { + "description": "The trained model is fully deallocated from this node.", + "name": "stopped" + }, + { + "description": "The trained model is being deallocated from this node.", + "name": "stopping" } ], - "specLocation": "ilm/_types/Phase.ts#L117-L121" - }, - { - "kind": "interface", "name": { - "name": "WaitForSnapshotAction", - "namespace": "ilm._types" + "name": "RoutingState", + "namespace": "ml._types" }, - "properties": [ + "specLocation": "ml/_types/TrainedModel.ts#L407-L428" + }, + { + "kind": "enum", + "members": [ { - "name": "policy", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "description": "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.", + "name": "skip_result" + }, + { + "description": "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.", + "name": "skip_model_update" } ], - "specLocation": "ilm/_types/Phase.ts#L145-L147" - }, - { - "kind": "interface", "name": { - "name": "LifecycleExplainUnmanaged", - "namespace": "ilm.explain_lifecycle" + "name": "RuleAction", + "namespace": "ml._types" }, - "properties": [ + "specLocation": "ml/_types/Rule.ts#L41-L50" + }, + { + "kind": "enum", + "members": [ { - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } + "name": "loading_old_state" }, { - "name": "managed", - "required": true, - "type": { - "kind": "literal_value", - "value": false - } + "name": "saving_new_state" + }, + { + "name": "stopped" + }, + { + "name": "failed" } ], - "specLocation": "ilm/explain_lifecycle/types.ts#L59-L62" + "name": { + "name": "SnapshotUpgradeState", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/Model.ts#L95-L100" }, { - "esQuirk": "This is a boolean that evolved into an enum. ES also accepts plain booleans for true and false.", "kind": "enum", "members": [ { - "name": "true" + "name": "first" }, { - "name": "false" + "name": "second" }, { - "name": "checksum" + "name": "none" } ], "name": { - "name": "IndexCheckOnStartup", - "namespace": "indices._types" + "name": "TokenizationTruncate", + "namespace": "ml._types" }, - "specLocation": "indices/_types/IndexSettings.ts#L270-L277" + "specLocation": "ml/_types/inference.ts#L338-L342" }, { "kind": "enum", "members": [ { - "name": "all" + "description": "The model definition is an ensemble model of decision trees.", + "name": "tree_ensemble" }, { - "name": "primaries" + "description": "A special type reserved for language identification models.", + "name": "lang_ident" }, { - "name": "new_primaries" + "description": "The stored definition is a PyTorch (specifically a TorchScript) model.\nCurrently only NLP models are supported.", + "name": "pytorch" + } + ], + "name": { + "name": "TrainedModelType", + "namespace": "ml._types" + }, + "specLocation": "ml/_types/TrainedModel.ts#L314-L328" + }, + { + "kind": "enum", + "members": [ + { + "name": "normal" }, { - "name": "none" + "name": "low" } ], "name": { - "name": "IndexRoutingAllocationOptions", - "namespace": "indices._types" + "name": "TrainingPriority", + "namespace": "ml._types" }, - "specLocation": "indices/_types/IndexRouting.ts#L38-L43" + "specLocation": "ml/_types/TrainedModel.ts#L364-L367" }, { "kind": "enum", "members": [ { - "name": "all" + "name": "global" }, { - "name": "primaries" + "name": "exact" }, { - "name": "replicas" + "name": "exact_fuzzy" }, { - "name": "none" + "name": "fuzzy" + }, + { + "name": "prefix" + }, + { + "name": "suffix" + }, + { + "name": "contains" + }, + { + "name": "lt" + }, + { + "name": "lte" + }, + { + "name": "gt" + }, + { + "name": "gte" + }, + { + "name": "always" } ], "name": { - "name": "IndexRoutingRebalanceOptions", - "namespace": "indices._types" + "name": "QueryRuleCriteriaType", + "namespace": "query_rules._types" }, - "specLocation": "indices/_types/IndexRouting.ts#L45-L50" + "specLocation": "query_rules/_types/QueryRuleset.ts#L95-L108" }, { "kind": "enum", "members": [ { - "codegenName": "ilm", - "name": "Index Lifecycle Management" - }, - { - "codegenName": "datastream", - "name": "Data stream lifecycle" + "name": "pinned" }, { - "codegenName": "unmanaged", - "name": "Unmanaged" + "name": "exclude" } ], "name": { - "name": "ManagedBy", - "namespace": "indices._types" + "name": "QueryRuleType", + "namespace": "query_rules._types" }, - "specLocation": "indices/_types/DataStream.ts#L32-L37" + "specLocation": "query_rules/_types/QueryRuleset.ts#L60-L63" }, { "kind": "enum", "members": [ { - "codegenName": "last", - "name": "_last" + "name": "min" }, { - "codegenName": "first", - "name": "_first" + "name": "max" + }, + { + "name": "sum" + }, + { + "name": "avg" + }, + { + "name": "value_count" } ], "name": { - "name": "SegmentSortMissing", - "namespace": "indices._types" + "name": "Metric", + "namespace": "rollup._types" }, - "specLocation": "indices/_types/IndexSegmentSort.ts#L43-L46" + "specLocation": "rollup/_types/Metric.ts#L22-L28" }, { "kind": "enum", "members": [ { - "aliases": [ - "MIN" - ], - "name": "min" + "name": "started" }, { - "aliases": [ - "MAX" - ], - "name": "max" + "name": "indexing" + }, + { + "name": "stopping" + }, + { + "name": "stopped" + }, + { + "name": "aborting" } ], "name": { - "name": "SegmentSortMode", - "namespace": "indices._types" + "name": "IndexingJobState", + "namespace": "rollup.get_jobs" }, - "specLocation": "indices/_types/IndexSegmentSort.ts#L36-L41" + "specLocation": "rollup/get_jobs/types.ts#L77-L83" }, { "kind": "enum", "members": [ { - "aliases": [ - "ASC" - ], - "name": "asc" + "codegenName": "PageView", + "name": "page_view" }, { - "aliases": [ - "DESC" - ], - "name": "desc" + "codegenName": "Search", + "name": "search" + }, + { + "codegenName": "SearchClick", + "name": "search_click" } ], "name": { - "name": "SegmentSortOrder", - "namespace": "indices._types" + "name": "EventType", + "namespace": "search_application._types" }, - "specLocation": "indices/_types/IndexSegmentSort.ts#L29-L34" + "specLocation": "search_application/_types/AnalyticsEvent.ts#L22-L26" }, { - "kind": "type_alias", + "kind": "enum", + "members": [ + { + "name": "cluster" + }, + { + "name": "indices" + }, + { + "name": "shards" + } + ], "name": { - "name": "SettingsSimilarity", - "namespace": "indices._types" - }, - "specLocation": "indices/_types/IndexSettings.ts#L178-L190", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "SettingsSimilarityBm25", - "namespace": "indices._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SettingsSimilarityBoolean", - "namespace": "indices._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SettingsSimilarityDfi", - "namespace": "indices._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SettingsSimilarityDfr", - "namespace": "indices._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SettingsSimilarityIb", - "namespace": "indices._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SettingsSimilarityLmd", - "namespace": "indices._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SettingsSimilarityLmj", - "namespace": "indices._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SettingsSimilarityScripted", - "namespace": "indices._types" - } - } - ], - "kind": "union_of" + "name": "StatsLevel", + "namespace": "searchable_snapshots._types" }, - "variants": { - "kind": "internal_tag", - "nonExhaustive": true, - "tag": "type" - } + "specLocation": "searchable_snapshots/_types/stats.ts#L20-L24" }, { - "kind": "interface", + "kind": "enum", + "members": [ + { + "name": "rest" + }, + { + "name": "cross_cluster" + } + ], "name": { - "name": "SettingsSimilarityBm25", - "namespace": "indices._types" + "name": "ApiKeyType", + "namespace": "security._types" }, - "properties": [ + "specLocation": "security/_types/ApiKey.ts#L115-L118" + }, + { + "isOpen": true, + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "BM25" - } + "name": "all" }, { - "name": "b", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "name": "cancel_task" }, { - "name": "discount_overlaps", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "manage" }, { - "name": "k1", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } + "name": "manage_api_key" + }, + { + "name": "manage_behavioral_analytics" + }, + { + "name": "manage_enrich" + }, + { + "name": "manage_index_templates" + }, + { + "name": "manage_inference" + }, + { + "name": "manage_ingest_pipelines" + }, + { + "name": "manage_logstash_pipelines" + }, + { + "name": "manage_ml" + }, + { + "name": "manage_own_api_key" + }, + { + "name": "manage_pipeline" + }, + { + "name": "manage_search_application" + }, + { + "name": "manage_search_query_rules" + }, + { + "name": "manage_search_synonyms" + }, + { + "name": "manage_security" + }, + { + "name": "manage_transform" + }, + { + "name": "monitor" + }, + { + "name": "monitor_enrich" + }, + { + "name": "monitor_inference" + }, + { + "name": "monitor_ml" + }, + { + "name": "monitor_transform" + }, + { + "name": "none" + }, + { + "name": "post_behavioral_analytics_event" + }, + { + "name": "read_pipeline" + }, + { + "name": "read_security" } ], - "specLocation": "indices/_types/IndexSettings.ts#L196-L201" - }, - { - "kind": "interface", "name": { - "name": "SettingsSimilarityBoolean", - "namespace": "indices._types" + "name": "ClusterPrivilege", + "namespace": "security._types" }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "boolean" - } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L192-L194" + "specLocation": "security/_types/Privileges.ts#L42-L199" }, { - "kind": "interface", - "name": { - "name": "SettingsSimilarityDfi", - "namespace": "indices._types" - }, - "properties": [ + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "DFI" - } + "description": "In this type of grant, you must supply the user ID and password for which you want to create the API key.", + "name": "password" }, { - "name": "independence_measure", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DFIIndependenceMeasure", - "namespace": "_types" - } - } + "description": "In this type of grant, you must supply an access token that was created by the Elasticsearch token service.\nIf you are activating a user profile, you can alternatively supply a JWT (either a JWT `access_token` or a JWT `id_token`).", + "name": "access_token" } ], - "specLocation": "indices/_types/IndexSettings.ts#L203-L206" - }, - { - "kind": "interface", "name": { - "name": "SettingsSimilarityDfr", - "namespace": "indices._types" + "name": "GrantType", + "namespace": "security._types" }, - "properties": [ + "specLocation": "security/_types/GrantType.ts#L20-L30" + }, + { + "isOpen": true, + "kind": "enum", + "members": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "DFR" - } + "name": "all" }, { - "name": "after_effect", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DFRAfterEffect", - "namespace": "_types" - } - } + "name": "auto_configure" }, { - "name": "basic_model", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DFRBasicModel", - "namespace": "_types" - } - } + "name": "create" }, { - "name": "normalization", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Normalization", - "namespace": "_types" - } - } + "name": "create_doc" + }, + { + "name": "create_index" + }, + { + "name": "delete" + }, + { + "name": "delete_index" + }, + { + "name": "index" + }, + { + "name": "maintenance" + }, + { + "name": "manage" + }, + { + "name": "manage_data_stream_lifecycle" + }, + { + "name": "monitor" + }, + { + "name": "none" + }, + { + "name": "read" + }, + { + "name": "view_index_metadata" + }, + { + "name": "write" } ], - "specLocation": "indices/_types/IndexSettings.ts#L208-L213" + "name": { + "name": "IndexPrivilege", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L386-L428" }, { - "kind": "interface", + "codegenNames": [ + "json_text", + "query", + "template" + ], + "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.", + "kind": "type_alias", "name": { - "name": "SettingsSimilarityIb", - "namespace": "indices._types" + "name": "IndicesPrivilegesQuery", + "namespace": "security._types" }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "IB" - } - }, - { - "name": "distribution", - "required": true, - "type": { + "specLocation": "security/_types/Privileges.ts#L341-L349", + "type": { + "items": [ + { "kind": "instance_of", "type": { - "name": "IBDistribution", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } - } - }, - { - "name": "lambda", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "IBLambda", - "namespace": "_types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } - } - }, - { - "name": "normalization", - "required": true, - "type": { + }, + { "kind": "instance_of", "type": { - "name": "Normalization", - "namespace": "_types" + "name": "RoleTemplateQuery", + "namespace": "security._types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L215-L220" + ], + "kind": "union_of" + } }, { "kind": "interface", "name": { - "name": "SettingsSimilarityLmd", - "namespace": "indices._types" + "name": "RoleTemplateQuery", + "namespace": "security._types" }, "properties": [ { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "LMDirichlet" - } - }, - { - "name": "mu", + "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.", + "extDocId": "templating-role-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query", + "name": "template", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "RoleTemplateScript", + "namespace": "security._types" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L222-L225" + "specLocation": "security/_types/Privileges.ts#L351-L361" }, { "kind": "interface", "name": { - "name": "SettingsSimilarityLmj", - "namespace": "indices._types" + "name": "RoleTemplateScript", + "namespace": "security._types" }, "properties": [ { - "name": "type", - "required": true, + "name": "source", + "required": false, "type": { - "kind": "literal_value", - "value": "LMJelinekMercer" + "kind": "instance_of", + "type": { + "name": "RoleTemplateInlineQuery", + "namespace": "security._types" + } } }, { - "name": "lambda", + "description": "The `id` for a stored script.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", + "name": "Id", "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L227-L230" - }, - { - "kind": "interface", - "name": { - "name": "SettingsSimilarityScripted", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "type", - "required": true, + "description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.", + "name": "params", + "required": false, "type": { - "kind": "literal_value", - "value": "scripted" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } } }, { - "name": "script", - "required": true, + "description": "Specifies the language the script is written in.", + "name": "lang", + "required": false, + "serverDefault": "painless", "type": { "kind": "instance_of", "type": { - "name": "Script", + "name": "ScriptLanguage", "namespace": "_types" } } }, { - "name": "weight_script", + "name": "options", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Script", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L232-L236" + "shortcutProperty": "source", + "specLocation": "security/_types/Privileges.ts#L363-L381" + }, + { + "codegenNames": [ + "query_string", + "query_object" + ], + "kind": "type_alias", + "name": { + "name": "RoleTemplateInlineQuery", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L383-L384", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "QueryContainer", + "namespace": "_types.query_dsl" + } + } + ], + "kind": "union_of" + } + }, + { + "kind": "enum", + "members": [], + "name": { + "name": "RemoteClusterPrivilege", + "namespace": "security._types" + }, + "specLocation": "security/_types/Privileges.ts#L201-L213" }, { + "isOpen": true, "kind": "enum", "members": [ { - "name": "disabled" - }, - { - "name": "stored" - }, - { - "name": "synthetic" + "name": "search_application_query" } ], "name": { - "name": "SourceMode", - "namespace": "indices._types" + "name": "RestrictionWorkflow", + "namespace": "security._types" }, - "specLocation": "indices/_types/IndexSettings.ts#L509-L513" + "specLocation": "security/_types/RoleDescriptor.ts#L143-L146" }, { - "isOpen": true, "kind": "enum", "members": [ { - "description": "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.", - "name": "fs" - }, - { - "description": "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.", - "name": "niofs" - }, - { - "description": "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.", - "name": "mmapfs" + "name": "string" }, { - "description": "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.", - "name": "hybridfs" + "name": "json" } ], "name": { - "name": "StorageType", - "namespace": "indices._types" + "name": "TemplateFormat", + "namespace": "security._types" }, - "specLocation": "indices/_types/IndexSettings.ts#L545-L573" + "specLocation": "security/_types/RoleTemplate.ts#L22-L25" + }, + { + "kind": "type_alias", + "name": { + "name": "UserProfileId", + "namespace": "security._types" + }, + "specLocation": "security/_types/UserProfile.ts#L25-L25", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "kind": "enum", "members": [ { - "aliases": [ - "REQUEST" - ], - "description": "(default) fsync and commit after every request. In the event of hardware failure, all acknowledged writes\nwill already have been committed to disk.", - "name": "request" + "description": "This grant type implements the Resource Owner Password Credentials Grant of OAuth2.\nIn this grant, a trusted client exchanges the end user's credentials for an access token and (possibly) a refresh token.\nThe request needs to be made by an authenticated user but happens on behalf of another authenticated user (the one whose credentials are passed as request parameters).\nThis grant type is not suitable or designed for the self-service user creation of tokens.", + "name": "password" }, { - "aliases": [ - "ASYNC" - ], - "description": "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.", - "name": "async" + "description": "This grant type implements the Client Credentials Grant of OAuth2.\nIt is geared for machine to machine communication and is not suitable or designed for the self-service user creation of tokens.\nIt generates only access tokens that cannot be refreshed.\nThe premise is that the entity that uses `client_credentials` has constant access to a set of (client, not end-user) credentials and can authenticate itself at will.", + "name": "client_credentials" + }, + { + "description": "This grant type is supported internally and implements SPNEGO based Kerberos support.\nThe `_kerberos` grant type may change from version to version.", + "name": "_kerberos" + }, + { + "description": "This grant type implements the Refresh Token Grant of OAuth2.\nIn this grant a user exchanges a previously issued refresh token for a new access token and a new refresh token.", + "name": "refresh_token" } ], "name": { - "name": "TranslogDurability", - "namespace": "indices._types" + "name": "AccessTokenGrantType", + "namespace": "security.get_token" }, - "specLocation": "indices/_types/IndexSettings.ts#L379-L394" + "specLocation": "security/get_token/types.ts#L23-L48" }, { "kind": "enum", "members": [ { - "description": "Disable metadata changes, such as closing the index.", - "name": "metadata" - }, - { - "description": "Disable read operations.", - "name": "read" - }, - { - "description": "Disable write operations and metadata changes.", - "name": "read_only" + "name": "access_token" }, { - "description": "Disable write operations. However, metadata changes are still allowed.", - "name": "write" + "name": "password" } ], "name": { - "name": "IndicesBlockOptions", - "namespace": "indices.add_block" + "name": "ApiKeyGrantType", + "namespace": "security.grant_api_key" }, - "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L91-L100" + "specLocation": "security/grant_api_key/types.ts#L47-L50" }, { "kind": "type_alias", "name": { - "name": "TextToAnalyze", - "namespace": "indices.analyze" + "name": "ApplicationsPrivileges", + "namespace": "security.has_privileges" }, - "specLocation": "indices/analyze/types.ts#L69-L69", + "specLocation": "security/has_privileges/types.ts#L47-L47", "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "key": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } - ], - "kind": "union_of" + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ResourcePrivileges", + "namespace": "security.has_privileges" + } + } } }, { - "kind": "enum", - "members": [ - { - "name": "aliases" - }, - { - "name": "mappings" + "kind": "type_alias", + "name": { + "name": "ResourcePrivileges", + "namespace": "security.has_privileges" + }, + "specLocation": "security/has_privileges/types.ts#L48-L48", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } }, - { - "name": "settings" + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Privileges", + "namespace": "security.has_privileges" + } } - ], + } + }, + { + "kind": "type_alias", "name": { - "name": "Feature", - "namespace": "indices.get" + "name": "Privileges", + "namespace": "security.has_privileges" }, - "specLocation": "indices/get/IndicesGetRequest.ts#L98-L102" + "specLocation": "security/has_privileges/types.ts#L49-L49", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } }, { "kind": "type_alias", "name": { - "name": "Features", - "namespace": "indices.get" + "name": "ApiKeyAggregate", + "namespace": "security.query_api_keys" }, - "specLocation": "indices/get/IndicesGetRequest.ts#L103-L103", + "specLocation": "security/query_api_keys/types.ts#L122-L139", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "Feature", - "namespace": "indices.get" + "name": "CardinalityAggregate", + "namespace": "_types.aggregations" } }, { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Feature", - "namespace": "indices.get" - } + "kind": "instance_of", + "type": { + "name": "ValueCountAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "StringTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "LongTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DoubleTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "UnmappedTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MultiTermsAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "MissingAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "FilterAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "FiltersAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "RangeAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "DateRangeAggregate", + "namespace": "_types.aggregations" + } + }, + { + "kind": "instance_of", + "type": { + "name": "CompositeAggregate", + "namespace": "_types.aggregations" } } ], "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [ - { - "name": "upgrade" - } - ], - "name": { - "name": "ModeEnum", - "namespace": "indices.migrate_reindex" }, - "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L54-L56" + "variants": { + "kind": "external_tag", + "nonExhaustive": true + } }, { "kind": "enum", "members": [ { - "name": "primary" + "name": "restart" }, { - "name": "replica" + "name": "remove" }, { - "name": "unused" + "name": "replace" } ], "name": { - "name": "ShardStoreAllocation", - "namespace": "indices.shard_stores" + "name": "Type", + "namespace": "shutdown._types" }, - "specLocation": "indices/shard_stores/types.ts#L47-L51" + "specLocation": "shutdown/_types/types.ts#L20-L24" }, { "kind": "enum", "members": [ { - "description": "The primary shard and all replica shards are assigned.", - "name": "green" - }, - { - "description": "One or more replica shards are unassigned.", - "name": "yellow" + "name": "not_started" }, { - "description": "The primary shard is unassigned.", - "name": "red" + "name": "in_progress" }, { - "description": "Return all shards, regardless of health status.", - "name": "all" - } - ], - "name": { - "name": "ShardStoreStatus", - "namespace": "indices.shard_stores" - }, - "specLocation": "indices/shard_stores/types.ts#L62-L71" - }, - { - "kind": "enum", - "members": [ - { - "name": "open" + "name": "stalled" }, { - "name": "close" + "name": "complete" } ], "name": { - "name": "IndexMetadataState", - "namespace": "indices.stats" + "name": "ShutdownStatus", + "namespace": "shutdown.get_node" }, - "specLocation": "indices/stats/types.ts#L225-L232" + "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L45-L50" }, { "kind": "enum", "members": [ { - "name": "UNASSIGNED" - }, - { - "name": "INITIALIZING" - }, - { - "name": "STARTED" + "name": "remove" }, { - "name": "RELOCATING" + "name": "restart" } ], "name": { - "name": "ShardRoutingState", - "namespace": "indices.stats" + "name": "ShutdownType", + "namespace": "shutdown.get_node" }, - "specLocation": "indices/stats/types.ts#L169-L174" + "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L40-L43" }, { - "description": "Text Embedding results containing bytes are represented as Dense\nVectors of bytes.", "kind": "type_alias", "name": { - "name": "DenseByteVector", - "namespace": "inference._types" + "name": "Repository", + "namespace": "snapshot._types" }, - "specLocation": "inference/_types/Results.ts#L47-L51", + "specLocation": "snapshot/_types/SnapshotRepository.ts#L24-L34", "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "byte", - "namespace": "_types" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "AzureRepository", + "namespace": "snapshot._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "GcsRepository", + "namespace": "snapshot._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "S3Repository", + "namespace": "snapshot._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SharedFileSystemRepository", + "namespace": "snapshot._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "ReadOnlyUrlRepository", + "namespace": "snapshot._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "SourceOnlyRepository", + "namespace": "snapshot._types" + } } - } - } - }, - { - "description": "Text Embedding results are represented as Dense Vectors\nof floats.", - "kind": "type_alias", - "name": { - "name": "DenseVector", - "namespace": "inference._types" + ], + "kind": "union_of" }, - "specLocation": "inference/_types/Results.ts#L30-L34", - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } + "variants": { + "kind": "internal_tag", + "nonExhaustive": true, + "tag": "type" } }, { - "kind": "type_alias", - "name": { - "name": "ServiceSettings", - "namespace": "inference._types" + "inherits": { + "type": { + "name": "RepositoryBase", + "namespace": "snapshot._types" + } }, - "specLocation": "inference/_types/Services.ts#L91-L91", - "type": { - "kind": "user_defined_value" - } - }, - { - "description": "Sparse Embedding tokens are represented as a dictionary\nof string to double.", - "kind": "type_alias", + "kind": "interface", "name": { - "name": "SparseVector", - "namespace": "inference._types" + "name": "AzureRepository", + "namespace": "snapshot._types" }, - "specLocation": "inference/_types/Results.ts#L24-L28", - "type": { - "key": { - "kind": "instance_of", + "properties": [ + { + "description": "The Azure repository type.", + "extDocId": "repository-azure", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-azure.html", + "name": "type", + "required": true, "type": { - "name": "string", - "namespace": "_builtins" + "kind": "literal_value", + "value": "azure" } }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", + { + "description": "The repository settings.", + "name": "settings", + "required": false, "type": { - "name": "float", - "namespace": "_types" + "kind": "instance_of", + "type": { + "name": "AzureRepositorySettings", + "namespace": "snapshot._types" + } } } - } + ], + "specLocation": "snapshot/_types/SnapshotRepository.ts#L40-L50" }, { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "TaskSettings", - "namespace": "inference._types" + "name": "RepositoryBase", + "namespace": "snapshot._types" }, - "specLocation": "inference/_types/Services.ts#L93-L93", - "type": { - "kind": "user_defined_value" - } + "properties": [ + { + "name": "uuid", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Uuid", + "namespace": "_types" + } + } + } + ], + "specLocation": "snapshot/_types/SnapshotRepository.ts#L36-L38" }, { - "kind": "enum", - "members": [ + "inherits": { + "type": { + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" + } + }, + "kind": "interface", + "name": { + "name": "AzureRepositorySettings", + "namespace": "snapshot._types" + }, + "properties": [ { - "name": "sparse_embedding" + "description": "The path to the repository data within the container.\nIt defaults to the root directory.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket.", + "name": "base_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "text_embedding" + "description": "The name of the Azure repository client to use.", + "name": "client", + "required": false, + "serverDefault": "default", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "rerank" + "description": "The Azure container.", + "name": "container", + "required": false, + "serverDefault": "elasticsearch-snapshots", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "completion" + "description": "The maxmimum batch size, between 1 and 256, used for `BlobBatch` requests.\nDefaults to 256 which is the maximum number supported by the Azure blob batch API.", + "name": "delete_objects_max_size", + "required": false, + "serverDefault": 256, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "name": "chat_completion" - } - ], - "name": { - "name": "TaskType", - "namespace": "inference._types" - }, - "specLocation": "inference/_types/TaskType.ts#L20-L29" - }, - { - "codegenNames": [ - "string", - "object" - ], - "kind": "type_alias", - "name": { - "name": "CompletionToolType", - "namespace": "inference.chat_completion_unified" - }, - "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L54-L57", - "type": { - "items": [ - { + "description": "Either `primary_only` or `secondary_only`.\nNote that if you set it to `secondary_only`, it will force `readonly` to `true`.", + "name": "location_mode", + "required": false, + "serverDefault": "primary_only", + "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - }, - { + } + }, + { + "description": "The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with `BlobBatch`.\nNote that the effective number of concurrent deletes is further limited by the Azure client connection and event loop thread limits.\nDefaults to 10, minimum is 1, maximum is 100.", + "name": "max_concurrent_batch_deletes", + "required": false, + "serverDefault": 10, + "type": { "kind": "instance_of", "type": { - "name": "CompletionToolChoice", - "namespace": "inference.chat_completion_unified" + "name": "integer", + "namespace": "_types" } } - ], - "kind": "union_of" - } + }, + { + "description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", + "name": "readonly", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "snapshot/_types/SnapshotRepository.ts#L145-L196" }, { - "description": "Controls which tool is called by the model.", "kind": "interface", "name": { - "name": "CompletionToolChoice", - "namespace": "inference.chat_completion_unified" + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" }, "properties": [ { - "description": "The type of the tool.", - "name": "type", - "required": true, + "description": "Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type.", + "name": "chunk_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "ByteSize", + "namespace": "_types" + } + } + }, + { + "description": "When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default.", + "name": "compress", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "The tool choice function.", - "name": "function", - "required": true, + "description": "The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings.", + "name": "max_restore_bytes_per_sec", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "CompletionToolChoiceFunction", - "namespace": "inference.chat_completion_unified" + "name": "ByteSize", + "namespace": "_types" + } + } + }, + { + "description": "The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings.", + "name": "max_snapshot_bytes_per_sec", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" } } } ], - "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L143-L155" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L116-L143" }, { - "description": "The tool choice function.", + "inherits": { + "type": { + "name": "RepositoryBase", + "namespace": "snapshot._types" + } + }, "kind": "interface", "name": { - "name": "CompletionToolChoiceFunction", - "namespace": "inference.chat_completion_unified" + "name": "GcsRepository", + "namespace": "snapshot._types" }, "properties": [ { - "description": "The name of the function to call.", - "name": "name", + "description": "The Google Cloud Storage repository type.", + "extDocId": "repository-gcs", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-gcs.html", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "gcs" + } + }, + { + "description": "The repository settings.", + "name": "settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "GcsRepositorySettings", + "namespace": "snapshot._types" } } } ], - "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L132-L141" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L52-L62" }, { - "codegenNames": [ - "string", - "object" - ], - "kind": "type_alias", + "inherits": { + "type": { + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" + } + }, + "kind": "interface", "name": { - "name": "MessageContent", - "namespace": "inference.chat_completion_unified" + "name": "GcsRepositorySettings", + "namespace": "snapshot._types" }, - "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L105-L108", - "type": { - "items": [ - { + "properties": [ + { + "description": "The name of the bucket to be used for snapshots.", + "name": "bucket", + "required": true, + "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } + } + }, + { + "deprecation": { + "description": "", + "version": "6.3.0" }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ContentObject", - "namespace": "inference.chat_completion_unified" - } + "description": "The name used by the client when it uses the Google Cloud Storage service.", + "name": "application_name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "description": "An object style representation of a single portion of a conversation.", - "kind": "interface", - "name": { - "name": "ContentObject", - "namespace": "inference.chat_completion_unified" - }, - "properties": [ + }, { - "description": "The text content.", - "name": "text", - "required": true, + "description": "The path to the repository data within the bucket.\nIt defaults to the root of the bucket.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket.", + "name": "base_path", + "required": false, "type": { "kind": "instance_of", "type": { @@ -100386,9 +104553,10 @@ } }, { - "description": "The type of content.", - "name": "type", - "required": true, + "description": "The name of the client to use to connect to Google Cloud Storage.", + "name": "client", + "required": false, + "serverDefault": "default", "type": { "kind": "instance_of", "type": { @@ -100396,697 +104564,824 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L59-L71" - }, - { - "kind": "enum", - "members": [ + }, { - "name": "text_embedding" + "description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", + "name": "readonly", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "HuggingFaceTaskType", - "namespace": "inference.put_hugging_face" - }, - "specLocation": "inference/put_hugging_face/PutHuggingFaceRequest.ts#L91-L93" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L198-L235" }, { - "kind": "enum", - "members": [ - { - "name": "hugging_face" + "inherits": { + "type": { + "name": "RepositoryBase", + "namespace": "snapshot._types" } - ], + }, + "kind": "interface", "name": { - "name": "ServiceType", - "namespace": "inference.put_hugging_face" + "name": "S3Repository", + "namespace": "snapshot._types" }, - "specLocation": "inference/put_hugging_face/PutHuggingFaceRequest.ts#L95-L97" - }, - { - "kind": "enum", - "members": [ - { - "name": "chat_completion" - }, + "properties": [ { - "name": "completion" + "description": "The S3 repository type.", + "extDocId": "repository-s3", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "s3" + } }, { - "name": "text_embedding" - } - ], - "name": { - "name": "OpenAITaskType", - "namespace": "inference.put_openai" - }, - "specLocation": "inference/put_openai/PutOpenAiRequest.ts#L84-L88" - }, - { - "kind": "enum", - "members": [ - { - "name": "openai" + "description": "The repository settings.\n\nNOTE: In addition to the specified settings, you can also use all non-secure client settings in the repository settings.\nIn this case, the client settings found in the repository settings will be merged with those of the named client used by the repository.\nConflicts between client and repository settings are resolved by the repository settings taking precedence over client settings.", + "name": "settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "S3RepositorySettings", + "namespace": "snapshot._types" + } + } } ], - "name": { - "name": "ServiceType", - "namespace": "inference.put_openai" - }, - "specLocation": "inference/put_openai/PutOpenAiRequest.ts#L90-L92" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L64-L78" }, { - "kind": "enum", - "members": [ - { - "name": "watsonxai" + "inherits": { + "type": { + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" } - ], - "name": { - "name": "ServiceType", - "namespace": "inference.put_watsonx" }, - "specLocation": "inference/put_watsonx/PutWatsonxRequest.ts#L76-L78" - }, - { - "kind": "enum", - "members": [ - { - "name": "text_embedding" - } - ], + "kind": "interface", "name": { - "name": "WatsonxTaskType", - "namespace": "inference.put_watsonx" + "name": "S3RepositorySettings", + "namespace": "snapshot._types" }, - "specLocation": "inference/put_watsonx/PutWatsonxRequest.ts#L72-L74" - }, - { - "kind": "enum", - "members": [ + "properties": [ { - "name": "integer" + "description": "The name of the S3 bucket to use for snapshots.\nThe bucket name must adhere to Amazon's S3 bucket naming rules.", + "extDocId": "repository-s3-naming", + "extDocUrl": "https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules", + "name": "bucket", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "long" + "description": "The path to the repository data within its bucket.\nIt defaults to an empty string, meaning that the repository is at the root of the bucket.\nThe value of this setting should not start or end with a forward slash (`/`).\n\nNOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments may share the same bucket.", + "name": "base_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "double" + "description": "The minimum threshold below which the chunk is uploaded using a single request.\nBeyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into several parts, each of `buffer_size` length, and to upload each part in its own request.\nNote that setting a buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result in upload errors.\nIt is also not possible to set a buffer size greater than 5gb as it is the maximum upload size allowed by S3.\nDefaults to `100mb` or 5% of JVM heap, whichever is smaller.", + "name": "buffer_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", + "namespace": "_types" + } + } }, { - "name": "float" + "description": "The S3 repository supports all S3 canned ACLs: `private`, `public-read`, `public-read-write`, `authenticated-read`, `log-delivery-write`, `bucket-owner-read`, `bucket-owner-full-control`.\nYou could specify a canned ACL using the `canned_acl` setting.\nWhen the S3 repository creates buckets and objects, it adds the canned ACL into the buckets and objects.", + "extDocId": "repository-s3-canned-acl", + "extDocUrl": "https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl", + "name": "canned_acl", + "required": false, + "serverDefault": "private", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "boolean" + "description": "The name of the S3 client to use to connect to S3.", + "name": "client", + "required": false, + "serverDefault": "default", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "ip" + "description": "The maxmimum batch size, between 1 and 1000, used for `DeleteObjects` requests.\nDefaults to 1000 which is the maximum number supported by the AWS DeleteObjects API.", + "extDocId": "repository-s3-delete-objects", + "extDocUrl": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html", + "name": "delete_objects_max_size", + "required": false, + "serverDefault": 1000, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "name": "string" + "description": "The time to wait before trying again if an attempt to read a linearizable register fails.", + "name": "get_register_retry_delay", + "required": false, + "serverDefault": "5s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } }, { - "name": "auto" - } - ], - "name": { - "name": "ConvertType", - "namespace": "ingest._types" - }, - "specLocation": "ingest/_types/Processors.ts#L662-L671" - }, - { - "kind": "enum", - "members": [ - { - "codegenName": "md5", - "name": "MD5" + "description": "The maximum number of parts that Elasticsearch will write during a multipart upload of a single object.\nFiles which are larger than `buffer_size × max_multipart_parts` will be chunked into several smaller objects.\nElasticsearch may also split a file across multiple objects to satisfy other constraints such as the `chunk_size` limit.\nDefaults to `10000` which is the maximum number of parts in a multipart upload in AWS S3.", + "name": "max_multipart_parts", + "required": false, + "serverDefault": 10000, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "codegenName": "sha1", - "name": "SHA-1" + "description": "The maximum number of possibly-dangling multipart uploads to clean up in each batch of snapshot deletions.\nDefaults to 1000 which is the maximum number supported by the AWS ListMultipartUploads API.\nIf set to `0`, Elasticsearch will not attempt to clean up dangling multipart uploads.", + "extDocId": "repository-s3-list-multipart", + "extDocUrl": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html", + "name": "max_multipart_upload_cleanup_size", + "required": false, + "serverDefault": 1000, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "codegenName": "sha256", - "name": "SHA-256" + "description": "If true, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", + "name": "readonly", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "codegenName": "sha512", - "name": "SHA-512" + "description": "When set to `true`, files are encrypted on server side using an AES256 algorithm.", + "name": "server_side_encryption", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "codegenName": "murmurHash3", - "name": "MurmurHash3" - } - ], - "name": { - "name": "FingerprintDigest", - "namespace": "ingest._types" - }, - "specLocation": "ingest/_types/Processors.ts#L897-L903" - }, - { - "kind": "enum", - "members": [ - { - "name": "geojson" + "description": "The S3 storage class for objects written to the repository.\nValues may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`.", + "extDocId": "repository-s3-storage-classes", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html#repository-s3-storage-classes", + "name": "storage_class", + "required": false, + "serverDefault": "standard", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "wkt" - } - ], - "name": { - "name": "GeoGridTargetFormat", - "namespace": "ingest._types" - }, - "specLocation": "ingest/_types/Processors.ts#L438-L441" - }, - { - "kind": "enum", - "members": [ - { - "name": "geotile" + "description": "The delay before the first retry and the amount the delay is incremented by on each subsequent retry.\nThe default is 50ms and the minimum is 0ms.", + "name": "throttled_delete_retry.delay_increment", + "required": false, + "serverDefault": "50ms", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } }, { - "name": "geohex" + "description": "The upper bound on how long the delays between retries will grow to.\nThe default is 5s and the minimum is 0ms.", + "name": "throttled_delete_retry.maximum_delay", + "required": false, + "serverDefault": "5s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } }, { - "name": "geohash" + "description": "The number times to retry a throttled snapshot deletion.\nThe default is 10 and the minimum value is 0 which will disable retries altogether.\nNote that if retries are enabled in the Azure client, each of these retries comprises that many client-level retries.", + "name": "throttled_delete_retry.maximum_number_of_retries", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } ], - "name": { - "name": "GeoGridTileType", - "namespace": "ingest._types" - }, - "specLocation": "ingest/_types/Processors.ts#L432-L436" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L237-L346" }, { - "kind": "enum", - "members": [ - { - "description": "Root fields that conflict with fields from the parsed JSON will be overridden.", - "name": "replace" - }, - { - "description": "Conflicting fields will be merged.", - "name": "merge" + "inherits": { + "type": { + "name": "RepositoryBase", + "namespace": "snapshot._types" } - ], - "name": { - "name": "JsonProcessorConflictStrategy", - "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1152-L1157" - }, - { - "kind": "enum", - "members": [ - { - "name": "geo_shape" - }, - { - "name": "shape" - } - ], + "kind": "interface", "name": { - "name": "ShapeType", - "namespace": "ingest._types" + "name": "SharedFileSystemRepository", + "namespace": "snapshot._types" }, - "specLocation": "ingest/_types/Processors.ts#L1474-L1477" - }, - { - "kind": "enum", - "members": [ - { - "name": "name" - }, - { - "name": "os" - }, - { - "name": "device" - }, + "properties": [ { - "name": "original" + "description": "The shared file system repository type.", + "extDocId": "repository-shared-fs", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-filesystem-repository.html", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "fs" + } }, { - "name": "version" + "description": "The repository settings.", + "name": "settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "SharedFileSystemRepositorySettings", + "namespace": "snapshot._types" + } + } } ], - "name": { - "name": "UserAgentProperty", - "namespace": "ingest._types" - }, - "specLocation": "ingest/_types/Processors.ts#L548-L554" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L80-L90" }, { - "kind": "enum", - "members": [ - { - "name": "active" - }, - { - "name": "valid" - }, - { - "name": "invalid" - }, - { - "name": "expired" + "inherits": { + "type": { + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" } - ], + }, + "kind": "interface", "name": { - "name": "LicenseStatus", - "namespace": "license._types" + "name": "SharedFileSystemRepositorySettings", + "namespace": "snapshot._types" }, - "specLocation": "license/_types/License.ts#L35-L40" - }, - { - "kind": "enum", - "members": [ - { - "name": "missing" - }, - { - "name": "trial" - }, - { - "name": "basic" - }, - { - "name": "standard" - }, - { - "name": "dev" - }, - { - "name": "silver" - }, + "properties": [ { - "name": "gold" + "description": "The location of the shared filesystem used to store and retrieve snapshots.\nThis location must be registered in the `path.repo` setting on all master and data nodes in the cluster.\nUnlike `path.repo`, this setting supports only a single file path.", + "name": "location", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "platinum" + "description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.", + "name": "max_number_of_snapshots", + "required": false, + "serverDefault": 2147483647, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "name": "enterprise" + "description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", + "name": "readonly", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "LicenseType", - "namespace": "license._types" - }, - "specLocation": "license/_types/License.ts#L23-L33" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L348-L375" }, { - "kind": "enum", - "members": [ - { - "name": "none" - }, - { - "name": "info" - }, - { - "description": "You can upgrade directly, but you are using deprecated functionality which will not be available or behave differently in the next major version.", - "name": "warning" - }, - { - "description": "You cannot upgrade without fixing this problem.", - "name": "critical" + "inherits": { + "type": { + "name": "RepositoryBase", + "namespace": "snapshot._types" } - ], + }, + "kind": "interface", "name": { - "name": "DeprecationLevel", - "namespace": "migration.deprecations" + "name": "ReadOnlyUrlRepository", + "namespace": "snapshot._types" }, - "specLocation": "migration/deprecations/types.ts#L23-L30" - }, - { - "kind": "enum", - "members": [ - { - "name": "NO_MIGRATION_NEEDED" - }, - { - "name": "MIGRATION_NEEDED" - }, + "properties": [ { - "name": "IN_PROGRESS" + "description": "The read-only URL repository type.", + "extDocId": "repository-read-only", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-read-only-repository.html", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "url" + } }, { - "name": "ERROR" + "description": "The repository settings.", + "name": "settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ReadOnlyUrlRepositorySettings", + "namespace": "snapshot._types" + } + } } ], - "name": { - "name": "MigrationStatus", - "namespace": "migration.get_feature_upgrade_status" - }, - "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts#L30-L35" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L92-L102" }, { - "kind": "enum", - "members": [ + "inherits": { + "type": { + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" + } + }, + "kind": "interface", + "name": { + "name": "ReadOnlyUrlRepositorySettings", + "namespace": "snapshot._types" + }, + "properties": [ { - "name": "actual" + "description": "The maximum number of retries for HTTP and HTTPS URLs.", + "name": "http_max_retries", + "required": false, + "serverDefault": 5, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "name": "typical" + "description": "The maximum wait time for data transfers over a connection.", + "name": "http_socket_timeout", + "required": false, + "serverDefault": "50s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } }, { - "name": "diff_from_typical" + "description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.", + "name": "max_number_of_snapshots", + "required": false, + "serverDefault": 2147483647, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } }, { - "name": "time" + "description": "The URL location of the root of the shared filesystem repository.\nThe following protocols are supported:\n\n* `file`\n* `ftp`\n* `http`\n* `https`\n* `jar`\n\nURLs using the HTTP, HTTPS, or FTP protocols must be explicitly allowed with the `repositories.url.allowed_urls` cluster setting.\nThis setting supports wildcards in the place of a host, path, query, or fragment in the URL.\n\nURLs using the file protocol must point to the location of a shared filesystem accessible to all master and data nodes in the cluster.\nThis location must be registered in the `path.repo` setting.\nYou don't need to register URLs using the FTP, HTTP, HTTPS, or JAR protocols in the `path.repo` setting.", + "name": "url", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "AppliesTo", - "namespace": "ml._types" - }, - "specLocation": "ml/_types/Rule.ts#L67-L72" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L377-L412" }, { - "codegenNames": [ - "name", - "definition" - ], - "kind": "type_alias", + "inherits": { + "type": { + "name": "RepositoryBase", + "namespace": "snapshot._types" + } + }, + "kind": "interface", "name": { - "name": "CategorizationAnalyzer", - "namespace": "ml._types" + "name": "SourceOnlyRepository", + "namespace": "snapshot._types" }, - "specLocation": "ml/_types/Analysis.ts#L181-L182", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { + "properties": [ + { + "description": "The source-only repository type.", + "extDocId": "repository-source-only", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-source-only-repository.html", + "name": "type", + "required": true, + "type": { + "kind": "literal_value", + "value": "source" + } + }, + { + "description": "The repository settings.", + "name": "settings", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "CategorizationAnalyzerDefinition", - "namespace": "ml._types" + "name": "SourceOnlyRepositorySettings", + "namespace": "snapshot._types" } } - ], - "kind": "union_of" - } + } + ], + "specLocation": "snapshot/_types/SnapshotRepository.ts#L104-L114" }, { + "inherits": { + "type": { + "name": "RepositorySettingsBase", + "namespace": "snapshot._types" + } + }, "kind": "interface", "name": { - "name": "CategorizationAnalyzerDefinition", - "namespace": "ml._types" + "name": "SourceOnlyRepositorySettings", + "namespace": "snapshot._types" }, "properties": [ { - "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.", - "name": "char_filter", + "description": "The delegated repository type. For valid values, refer to the `type` parameter.\nSource repositories can use `settings` properties for its delegated repository type.", + "name": "delegate_type", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CharFilter", - "namespace": "_types.analysis" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "filter", + "description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.", + "name": "max_number_of_snapshots", "required": false, + "serverDefault": 2147483647, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TokenFilter", - "namespace": "_types.analysis" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "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`.", - "extDocId": "analysis-tokenizers", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", - "name": "tokenizer", + "aliases": [ + "readonly" + ], + "description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", + "name": "read_only", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Tokenizer", - "namespace": "_types.analysis" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "ml/_types/Analysis.ts#L184-L198" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L414-L441" }, { "kind": "enum", "members": [ { - "name": "ok" + "description": "The number of shards in the snapshot that were successfully stored in the repository.", + "name": "DONE" }, { - "name": "warn" - } - ], - "name": { - "name": "CategorizationStatus", - "namespace": "ml._types" - }, - "specLocation": "ml/_types/Model.ts#L84-L87" - }, - { - "kind": "enum", - "members": [ + "description": "The number of shards in the snapshot that were not successfully stored in the repository.", + "name": "FAILURE" + }, { - "name": "auto" + "description": "The number of shards in the snapshot that are in the finalizing stage of being stored in the repository.", + "name": "FINALIZE" }, { - "name": "manual" + "description": "The number of shards in the snapshot that are in the initializing stage of being stored in the repository.", + "name": "INIT" }, { - "name": "off" + "description": "The number of shards in the snapshot that are in the started stage of being stored in the repository.", + "name": "STARTED" } ], "name": { - "name": "ChunkingMode", - "namespace": "ml._types" + "name": "ShardsStatsStage", + "namespace": "snapshot._types" }, - "specLocation": "ml/_types/Datafeed.ts#L245-L249" + "specLocation": "snapshot/_types/SnapshotShardsStatsStage.ts#L20-L31" }, { "kind": "enum", "members": [ { - "name": "gt" + "name": "start_time" }, { - "name": "gte" + "name": "duration" }, { - "name": "lt" + "name": "name" }, { - "name": "lte" + "name": "index_count" + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "name": "repository" + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "name": "shard_count" + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "name": "failed_shard_count" } ], "name": { - "name": "ConditionOperator", - "namespace": "ml._types" + "name": "SnapshotSort", + "namespace": "snapshot._types" }, - "specLocation": "ml/_types/Rule.ts#L74-L79" + "specLocation": "snapshot/_types/SnapshotInfo.ts#L73-L93" }, { - "description": "Custom metadata about the job", "kind": "type_alias", "name": { - "name": "CustomSettings", - "namespace": "ml._types" + "name": "Row", + "namespace": "sql._types" }, - "specLocation": "ml/_types/Settings.ts#L22-L27", + "specLocation": "sql/_types/types.ts#L28-L28", "type": { - "kind": "user_defined_value" + "kind": "array_of", + "value": { + "kind": "user_defined_value" + } } }, { "kind": "enum", "members": [ { - "name": "started" - }, - { - "name": "stopped" + "name": "csv" }, { - "name": "starting" + "name": "json" }, { - "name": "stopping" - } - ], - "name": { - "name": "DatafeedState", - "namespace": "ml._types" - }, - "specLocation": "ml/_types/Datafeed.ts#L136-L141" - }, - { - "kind": "enum", - "members": [ - { - "name": "started" + "name": "tsv" }, { - "name": "stopped" + "name": "txt" }, { - "name": "starting" + "name": "yaml" }, { - "name": "stopping" + "name": "cbor" }, { - "name": "failed" + "name": "smile" } ], "name": { - "name": "DataframeState", - "namespace": "ml._types" + "name": "SqlFormat", + "namespace": "sql.query" }, - "specLocation": "ml/_types/Dataframe.ts#L20-L26" + "specLocation": "sql/query/QuerySqlRequest.ts#L154-L162" }, { - "kind": "enum", - "members": [ - { - "description": "The trained model is started on at least one node.", - "name": "started" - }, - { - "description": "Trained model deployment is starting but it is not yet deployed on any nodes.", - "name": "starting" - }, - { - "description": "Trained model deployment has started on all valid nodes.", - "name": "fully_allocated" - } - ], + "kind": "type_alias", "name": { - "name": "DeploymentAllocationState", - "namespace": "ml._types" + "name": "SynonymString", + "namespace": "synonyms._types" }, - "specLocation": "ml/_types/TrainedModel.ts#L330-L343" + "specLocation": "synonyms/_types/SynonymRule.ts#L23-L23", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "kind": "enum", "members": [ { - "description": "The deployment is usable; at least one node has the model allocated.", - "name": "started" - }, - { - "description": "The deployment has recently started but is not yet usable; the model is not allocated on any nodes.", - "name": "starting" + "description": "Group tasks by node ID.", + "name": "nodes" }, { - "description": "The deployment is preparing to stop and deallocate the model from the relevant nodes.", - "name": "stopping" + "description": "Group tasks by parent task ID.", + "name": "parents" }, { - "description": "The deployment is on a failed state and must be re-deployed.", - "name": "failed" + "description": "Do not group tasks.", + "name": "none" } ], "name": { - "name": "DeploymentAssignmentState", - "namespace": "ml._types" + "name": "GroupBy", + "namespace": "tasks._types" }, - "specLocation": "ml/_types/TrainedModel.ts#L345-L362" + "specLocation": "tasks/_types/GroupBy.ts#L20-L27" }, { + "codegenNames": [ + "flat", + "grouped" + ], "kind": "type_alias", "name": { - "name": "DiscoveryNode", - "namespace": "ml._types" + "name": "TaskInfos", + "namespace": "tasks._types" }, - "specLocation": "ml/_types/DiscoveryNode.ts#L25-L25", + "specLocation": "tasks/_types/TaskListResponseBase.ts#L40-L43", "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "DiscoveryNodeContent", - "namespace": "ml._types" + "items": [ + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TaskInfo", + "namespace": "tasks._types" + } + } + }, + { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ParentTaskInfo", + "namespace": "tasks._types" + } + } } - } + ], + "kind": "union_of" } }, { "kind": "interface", "name": { - "name": "DiscoveryNodeContent", - "namespace": "ml._types" + "name": "TaskInfo", + "namespace": "tasks._types" }, "properties": [ { - "name": "name", - "required": false, + "name": "action", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "ephemeral_id", - "required": true, + "name": "cancelled", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "transport_address", + "name": "cancellable", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TransportAddress", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "external_id", - "required": true, + "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.", + "name": "description", + "required": false, "type": { "kind": "instance_of", "type": { @@ -101096,7 +105391,7 @@ } }, { - "name": "attributes", + "name": "headers", "required": true, "type": { "key": { @@ -101118,2152 +105413,1733 @@ } }, { - "name": "roles", + "name": "id", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "name": "version", + "name": "node", "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "NodeId", "namespace": "_types" } } }, { - "name": "min_index_version", - "required": true, + "name": "running_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "Duration", "namespace": "_types" } } }, { - "name": "max_index_version", + "name": "running_time_in_nanos", "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitNanos", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "integer", + "name": "DurationValue", "namespace": "_types" } } - } - ], - "specLocation": "ml/_types/DiscoveryNode.ts#L27-L37" - }, - { - "kind": "enum", - "members": [ + }, { - "name": "all" + "name": "start_time_in_millis", + "required": true, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } }, { - "name": "none" + "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.", + "name": "status", + "required": false, + "type": { + "kind": "user_defined_value" + } }, { - "name": "by" + "name": "type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "over" + "name": "parent_task_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TaskId", + "namespace": "_types" + } + } } ], + "specLocation": "tasks/_types/TaskInfo.ts#L32-L58" + }, + { + "inherits": { + "type": { + "name": "TaskInfo", + "namespace": "tasks._types" + } + }, + "kind": "interface", "name": { - "name": "ExcludeFrequent", - "namespace": "ml._types" + "name": "ParentTaskInfo", + "namespace": "tasks._types" }, - "specLocation": "ml/_types/Detector.ts#L145-L150" + "properties": [ + { + "name": "children", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TaskInfo", + "namespace": "tasks._types" + } + } + } + } + ], + "specLocation": "tasks/_types/TaskListResponseBase.ts#L45-L47" }, { "kind": "enum", "members": [ { - "name": "include" + "name": "disabled" }, { - "name": "exclude" + "name": "v1" } ], "name": { - "name": "FilterType", - "namespace": "ml._types" + "name": "EcsCompatibilityType", + "namespace": "text_structure._types" }, - "specLocation": "ml/_types/Filter.ts#L43-L46" + "specLocation": "text_structure/_types/Structure.ts#L40-L43" }, { "kind": "enum", "members": [ { - "description": "Includes the model definition.", - "name": "definition" - }, - { - "description": "Includes the baseline for feature importance values.", - "name": "feature_importance_baseline" + "name": "delimited" }, { - "description": "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.", - "name": "hyperparameters" + "name": "ndjson" }, { - "description": "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.", - "name": "total_feature_importance" + "name": "semi_structured_text" }, { - "description": "Includes the model definition status.", - "name": "definition_status" + "name": "xml" } ], "name": { - "name": "Include", - "namespace": "ml._types" + "name": "FormatType", + "namespace": "text_structure._types" }, - "specLocation": "ml/_types/Include.ts#L20-L47" + "specLocation": "text_structure/_types/Structure.ts#L45-L50" }, { "kind": "enum", "members": [ { - "name": "delete" + "name": "awaits_successful_execution" }, { - "name": "reset" + "name": "ackable" }, { - "name": "revert" + "name": "acked" } ], "name": { - "name": "JobBlockedReason", - "namespace": "ml._types" + "name": "AcknowledgementOptions", + "namespace": "watcher._types" }, - "specLocation": "ml/_types/Job.ts#L397-L401" + "specLocation": "watcher/_types/Action.ts#L103-L107" }, { "kind": "enum", "members": [ { - "description": "The job close action is in progress and has not yet completed. A closing job cannot accept further data.", - "name": "closing" + "description": "The action execution is simulated. Each action type defines its own simulation operation mode. For example, the email action creates the email that would have been sent but does not actually send it. In this mode, the action might be throttled if the current state of the watch indicates it should be.", + "name": "simulate" }, { - "description": "The job finished successfully with its model state persisted. The job must be opened before it can accept further data.", - "name": "closed" + "description": "Similar to the `simulate` mode, except the action is not throttled even if the current state of the watch indicates it should be.", + "name": "force_simulate" }, { - "description": "The job is available to receive and process data.", - "name": "opened" + "description": "Executes the action as it would have been executed if the watch had been triggered by its own trigger. The execution might be throttled if the current state of the watch indicates it should be.", + "name": "execute" }, { - "description": "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.", - "name": "failed" + "description": "Similar to the `execute` mode, except the action is not throttled even if the current state of the watch indicates it should be.", + "name": "force_execute" }, { - "description": "The job open action is in progress and has not yet completed.", - "name": "opening" + "description": "The action is skipped and is not executed or simulated. Effectively forces the action to be throttled.", + "name": "skip" } ], "name": { - "name": "JobState", - "namespace": "ml._types" + "name": "ActionExecutionMode", + "namespace": "watcher._types" }, - "specLocation": "ml/_types/Job.ts#L36-L52" + "specLocation": "watcher/_types/Action.ts#L67-L88" }, { "kind": "enum", "members": [ { - "name": "ok" + "name": "success" }, { - "name": "soft_limit" + "name": "failure" }, { - "name": "hard_limit" + "name": "simulated" + }, + { + "name": "throttled" } ], "name": { - "name": "MemoryStatus", - "namespace": "ml._types" - }, - "specLocation": "ml/_types/Model.ts#L89-L93" - }, - { - "kind": "type_alias", - "name": { - "name": "PredictedValue", - "namespace": "ml._types" + "name": "ActionStatusOptions", + "namespace": "watcher._types" }, - "specLocation": "ml/_types/inference.ts#L445-L445", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "ScalarValue", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ScalarValue", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" - } + "specLocation": "watcher/_types/Action.ts#L96-L101" }, { "kind": "enum", "members": [ { - "description": "The allocation attempt failed.", - "name": "failed" + "name": "email" }, { - "description": "The trained model is allocated and ready to accept inference requests.", - "name": "started" + "name": "webhook" }, { - "description": "The trained model is attempting to allocate on this node; inference requests are not yet accepted.", - "name": "starting" + "name": "index" }, { - "description": "The trained model is fully deallocated from this node.", - "name": "stopped" + "name": "logging" }, { - "description": "The trained model is being deallocated from this node.", - "name": "stopping" + "name": "slack" + }, + { + "name": "pagerduty" } ], "name": { - "name": "RoutingState", - "namespace": "ml._types" + "name": "ActionType", + "namespace": "watcher._types" }, - "specLocation": "ml/_types/TrainedModel.ts#L407-L428" + "specLocation": "watcher/_types/Action.ts#L58-L65" }, { - "kind": "enum", - "members": [ - { - "description": "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.", - "name": "skip_result" - }, - { - "description": "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.", - "name": "skip_model_update" - } - ], + "kind": "type_alias", "name": { - "name": "RuleAction", - "namespace": "ml._types" + "name": "Actions", + "namespace": "watcher._types" }, - "specLocation": "ml/_types/Rule.ts#L41-L50" + "specLocation": "watcher/_types/Action.ts#L56-L56", + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ActionStatus", + "namespace": "watcher._types" + } + } + } }, { - "kind": "enum", - "members": [ + "kind": "interface", + "name": { + "name": "ActionStatus", + "namespace": "watcher._types" + }, + "properties": [ { - "name": "loading_old_state" + "name": "ack", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AcknowledgeState", + "namespace": "watcher._types" + } + } }, { - "name": "saving_new_state" + "name": "last_execution", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExecutionState", + "namespace": "watcher._types" + } + } }, { - "name": "stopped" + "name": "last_successful_execution", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ExecutionState", + "namespace": "watcher._types" + } + } }, { - "name": "failed" + "name": "last_throttle", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ThrottleState", + "namespace": "watcher._types" + } + } } ], - "name": { - "name": "SnapshotUpgradeState", - "namespace": "ml._types" - }, - "specLocation": "ml/_types/Model.ts#L95-L100" + "specLocation": "watcher/_types/Action.ts#L125-L130" }, { - "kind": "enum", - "members": [ - { - "name": "first" - }, - { - "name": "second" - }, - { - "name": "none" - } - ], + "kind": "interface", "name": { - "name": "TokenizationTruncate", - "namespace": "ml._types" + "name": "AcknowledgeState", + "namespace": "watcher._types" }, - "specLocation": "ml/_types/inference.ts#L338-L342" - }, - { - "kind": "enum", - "members": [ - { - "description": "The model definition is an ensemble model of decision trees.", - "name": "tree_ensemble" - }, + "properties": [ { - "description": "A special type reserved for language identification models.", - "name": "lang_ident" + "name": "state", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AcknowledgementOptions", + "namespace": "watcher._types" + } + } }, { - "description": "The stored definition is a PyTorch (specifically a TorchScript) model.\nCurrently only NLP models are supported.", - "name": "pytorch" + "name": "timestamp", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } + } } ], - "name": { - "name": "TrainedModelType", - "namespace": "ml._types" - }, - "specLocation": "ml/_types/TrainedModel.ts#L314-L328" + "specLocation": "watcher/_types/Action.ts#L109-L112" }, { - "kind": "enum", - "members": [ - { - "name": "normal" - }, - { - "name": "low" - } - ], + "kind": "interface", "name": { - "name": "TrainingPriority", - "namespace": "ml._types" + "name": "ExecutionState", + "namespace": "watcher._types" }, - "specLocation": "ml/_types/TrainedModel.ts#L364-L367" - }, - { - "kind": "enum", - "members": [ - { - "name": "global" - }, - { - "name": "exact" - }, - { - "name": "exact_fuzzy" - }, - { - "name": "fuzzy" - }, - { - "name": "prefix" - }, - { - "name": "suffix" - }, - { - "name": "contains" - }, - { - "name": "lt" - }, - { - "name": "lte" - }, + "properties": [ { - "name": "gt" + "name": "successful", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "name": "gte" + "name": "timestamp", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } + } }, { - "name": "always" + "name": "reason", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "QueryRuleCriteriaType", - "namespace": "query_rules._types" - }, - "specLocation": "query_rules/_types/QueryRuleset.ts#L95-L108" + "specLocation": "watcher/_types/Action.ts#L114-L118" }, { - "kind": "enum", - "members": [ + "kind": "interface", + "name": { + "name": "ThrottleState", + "namespace": "watcher._types" + }, + "properties": [ { - "name": "pinned" + "name": "reason", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "exclude" + "name": "timestamp", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } + } } ], - "name": { - "name": "QueryRuleType", - "namespace": "query_rules._types" - }, - "specLocation": "query_rules/_types/QueryRuleset.ts#L60-L63" + "specLocation": "watcher/_types/Action.ts#L120-L123" }, { "kind": "enum", "members": [ { - "name": "min" + "name": "not_eq" }, { - "name": "max" + "name": "eq" }, { - "name": "sum" + "name": "lt" }, { - "name": "avg" + "name": "gt" }, { - "name": "value_count" + "name": "lte" + }, + { + "name": "gte" } ], "name": { - "name": "Metric", - "namespace": "rollup._types" + "name": "ConditionOp", + "namespace": "watcher._types" }, - "specLocation": "rollup/_types/Metric.ts#L22-L28" + "specLocation": "watcher/_types/Conditions.ts#L41-L48" }, { "kind": "enum", "members": [ { - "name": "started" + "name": "always" }, { - "name": "indexing" + "name": "never" }, { - "name": "stopping" + "name": "script" }, { - "name": "stopped" + "name": "compare" }, { - "name": "aborting" + "name": "array_compare" } ], "name": { - "name": "IndexingJobState", - "namespace": "rollup.get_jobs" + "name": "ConditionType", + "namespace": "watcher._types" }, - "specLocation": "rollup/get_jobs/types.ts#L77-L83" + "specLocation": "watcher/_types/Conditions.ts#L64-L70" }, { "kind": "enum", "members": [ { - "codegenName": "PageView", - "name": "page_view" - }, - { - "codegenName": "Search", - "name": "search" + "name": "http" }, { - "codegenName": "SearchClick", - "name": "search_click" + "name": "https" } ], "name": { - "name": "EventType", - "namespace": "search_application._types" + "name": "ConnectionScheme", + "namespace": "watcher._types" }, - "specLocation": "search_application/_types/AnalyticsEvent.ts#L22-L26" + "specLocation": "watcher/_types/Input.ts#L39-L42" }, { - "kind": "enum", - "members": [ - { - "name": "cluster" - }, - { - "name": "indices" - }, - { - "name": "shards" - } - ], + "docId": "cron-expressions", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-cron-expressions", + "kind": "type_alias", "name": { - "name": "StatsLevel", - "namespace": "searchable_snapshots._types" + "name": "CronExpression", + "namespace": "watcher._types" }, - "specLocation": "searchable_snapshots/_types/stats.ts#L20-L24" + "specLocation": "watcher/_types/Schedule.ts#L27-L30", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { "kind": "enum", "members": [ { - "name": "rest" + "name": "json" }, { - "name": "cross_cluster" + "name": "yaml" } ], "name": { - "name": "ApiKeyType", - "namespace": "security._types" + "name": "DataAttachmentFormat", + "namespace": "watcher._types" }, - "specLocation": "security/_types/ApiKey.ts#L115-L118" + "specLocation": "watcher/_types/Actions.ts#L187-L190" }, { - "isOpen": true, "kind": "enum", "members": [ { - "name": "all" - }, - { - "name": "cancel_task" - }, - { - "name": "manage" - }, - { - "name": "manage_api_key" - }, - { - "name": "manage_behavioral_analytics" - }, - { - "name": "manage_enrich" - }, - { - "name": "manage_index_templates" - }, - { - "name": "manage_inference" - }, - { - "name": "manage_ingest_pipelines" - }, - { - "name": "manage_logstash_pipelines" - }, - { - "name": "manage_ml" - }, - { - "name": "manage_own_api_key" - }, - { - "name": "manage_pipeline" - }, - { - "name": "manage_search_application" - }, - { - "name": "manage_search_query_rules" - }, - { - "name": "manage_search_synonyms" - }, - { - "name": "manage_security" - }, - { - "name": "manage_transform" - }, - { - "name": "monitor" - }, - { - "name": "monitor_enrich" - }, - { - "name": "monitor_inference" + "name": "sunday" }, { - "name": "monitor_ml" + "name": "monday" }, { - "name": "monitor_transform" + "name": "tuesday" }, { - "name": "none" + "name": "wednesday" }, { - "name": "post_behavioral_analytics_event" + "name": "thursday" }, { - "name": "read_pipeline" + "name": "friday" }, { - "name": "read_security" + "name": "saturday" } ], "name": { - "name": "ClusterPrivilege", - "namespace": "security._types" + "name": "Day", + "namespace": "watcher._types" }, - "specLocation": "security/_types/Privileges.ts#L42-L199" + "specLocation": "watcher/_types/Schedule.ts#L37-L45" }, { "kind": "enum", "members": [ { - "description": "In this type of grant, you must supply the user ID and password for which you want to create the API key.", - "name": "password" + "name": "lowest" }, { - "description": "In this type of grant, you must supply an access token that was created by the Elasticsearch token service.\nIf you are activating a user profile, you can alternatively supply a JWT (either a JWT `access_token` or a JWT `id_token`).", - "name": "access_token" + "name": "low" + }, + { + "name": "normal" + }, + { + "name": "high" + }, + { + "name": "highest" } ], "name": { - "name": "GrantType", - "namespace": "security._types" + "name": "EmailPriority", + "namespace": "watcher._types" }, - "specLocation": "security/_types/GrantType.ts#L20-L30" + "specLocation": "watcher/_types/Actions.ts#L197-L203" }, { - "isOpen": true, "kind": "enum", "members": [ { - "name": "all" + "name": "awaits_execution" }, { - "name": "auto_configure" + "name": "started" }, { - "name": "create" + "name": "input" }, { - "name": "create_doc" + "name": "condition" }, { - "name": "create_index" + "name": "actions" }, { - "name": "delete" + "name": "watch_transform" }, { - "name": "delete_index" + "name": "aborted" }, { - "name": "index" - }, + "name": "finished" + } + ], + "name": { + "name": "ExecutionPhase", + "namespace": "watcher._types" + }, + "specLocation": "watcher/_types/Execution.ts#L49-L58" + }, + { + "kind": "enum", + "members": [ { - "name": "maintenance" + "name": "awaits_execution" }, { - "name": "manage" + "name": "checking" }, { - "name": "manage_data_stream_lifecycle" + "name": "execution_not_needed" }, { - "name": "monitor" + "name": "throttled" }, { - "name": "none" + "name": "executed" }, { - "name": "read" + "name": "failed" }, { - "name": "view_index_metadata" + "name": "deleted_while_queued" }, { - "name": "write" + "name": "not_executed_already_queued" } ], "name": { - "name": "IndexPrivilege", - "namespace": "security._types" - }, - "specLocation": "security/_types/Privileges.ts#L386-L428" - }, - { - "codegenNames": [ - "json_text", - "query", - "template" - ], - "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.", - "kind": "type_alias", - "name": { - "name": "IndicesPrivilegesQuery", - "namespace": "security._types" - }, - "specLocation": "security/_types/Privileges.ts#L341-L349", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - }, - { - "kind": "instance_of", - "type": { - "name": "RoleTemplateQuery", - "namespace": "security._types" - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "RoleTemplateQuery", - "namespace": "security._types" + "name": "ExecutionStatus", + "namespace": "watcher._types" }, - "properties": [ - { - "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.", - "extDocId": "templating-role-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query", - "name": "template", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RoleTemplateScript", - "namespace": "security._types" - } - } - } - ], - "specLocation": "security/_types/Privileges.ts#L351-L361" + "specLocation": "watcher/_types/Execution.ts#L38-L47" }, { - "kind": "interface", - "name": { - "name": "RoleTemplateScript", - "namespace": "security._types" - }, - "properties": [ + "kind": "enum", + "members": [ { - "name": "source", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RoleTemplateInlineQuery", - "namespace": "security._types" - } - } + "name": "head" }, { - "description": "The `id` for a stored script.", - "name": "id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } + "name": "get" }, { - "description": "Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time.", - "name": "params", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } + "name": "post" }, { - "description": "Specifies the language the script is written in.", - "name": "lang", - "required": false, - "serverDefault": "painless", - "type": { - "kind": "instance_of", - "type": { - "name": "ScriptLanguage", - "namespace": "_types" - } - } + "name": "put" }, { - "name": "options", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } + "name": "delete" } ], - "shortcutProperty": "source", - "specLocation": "security/_types/Privileges.ts#L363-L381" - }, - { - "codegenNames": [ - "query_string", - "query_object" - ], - "kind": "type_alias", - "name": { - "name": "RoleTemplateInlineQuery", - "namespace": "security._types" - }, - "specLocation": "security/_types/Privileges.ts#L383-L384", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - ], - "kind": "union_of" - } - }, - { - "kind": "enum", - "members": [], "name": { - "name": "RemoteClusterPrivilege", - "namespace": "security._types" + "name": "HttpInputMethod", + "namespace": "watcher._types" }, - "specLocation": "security/_types/Privileges.ts#L201-L213" + "specLocation": "watcher/_types/Input.ts#L59-L65" }, { - "isOpen": true, "kind": "enum", "members": [ { - "name": "search_application_query" - } - ], - "name": { - "name": "RestrictionWorkflow", - "namespace": "security._types" - }, - "specLocation": "security/_types/RoleDescriptor.ts#L143-L146" - }, - { - "kind": "enum", - "members": [ + "name": "http" + }, { - "name": "string" + "name": "search" }, { - "name": "json" + "name": "simple" } ], "name": { - "name": "TemplateFormat", - "namespace": "security._types" - }, - "specLocation": "security/_types/RoleTemplate.ts#L22-L25" - }, - { - "kind": "type_alias", - "name": { - "name": "UserProfileId", - "namespace": "security._types" + "name": "InputType", + "namespace": "watcher._types" }, - "specLocation": "security/_types/UserProfile.ts#L25-L25", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "specLocation": "watcher/_types/Input.ts#L100-L104" }, { "kind": "enum", "members": [ { - "description": "This grant type implements the Resource Owner Password Credentials Grant of OAuth2.\nIn this grant, a trusted client exchanges the end user's credentials for an access token and (possibly) a refresh token.\nThe request needs to be made by an authenticated user but happens on behalf of another authenticated user (the one whose credentials are passed as request parameters).\nThis grant type is not suitable or designed for the self-service user creation of tokens.", - "name": "password" + "name": "january" + }, + { + "name": "february" + }, + { + "name": "march" + }, + { + "name": "april" + }, + { + "name": "may" + }, + { + "name": "june" + }, + { + "name": "july" + }, + { + "name": "august" }, { - "description": "This grant type implements the Client Credentials Grant of OAuth2.\nIt is geared for machine to machine communication and is not suitable or designed for the self-service user creation of tokens.\nIt generates only access tokens that cannot be refreshed.\nThe premise is that the entity that uses `client_credentials` has constant access to a set of (client, not end-user) credentials and can authenticate itself at will.", - "name": "client_credentials" + "name": "september" }, { - "description": "This grant type is supported internally and implements SPNEGO based Kerberos support.\nThe `_kerberos` grant type may change from version to version.", - "name": "_kerberos" + "name": "october" }, { - "description": "This grant type implements the Refresh Token Grant of OAuth2.\nIn this grant a user exchanges a previously issued refresh token for a new access token and a new refresh token.", - "name": "refresh_token" + "name": "november" + }, + { + "name": "december" } ], "name": { - "name": "AccessTokenGrantType", - "namespace": "security.get_token" + "name": "Month", + "namespace": "watcher._types" }, - "specLocation": "security/get_token/types.ts#L23-L48" + "specLocation": "watcher/_types/Schedule.ts#L65-L78" }, { "kind": "enum", "members": [ { - "name": "access_token" + "name": "link" }, { - "name": "password" + "name": "image" } ], "name": { - "name": "ApiKeyGrantType", - "namespace": "security.grant_api_key" - }, - "specLocation": "security/grant_api_key/types.ts#L47-L50" - }, - { - "kind": "type_alias", - "name": { - "name": "ApplicationsPrivileges", - "namespace": "security.has_privileges" - }, - "specLocation": "security/has_privileges/types.ts#L47-L47", - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ResourcePrivileges", - "namespace": "security.has_privileges" - } - } - } - }, - { - "kind": "type_alias", - "name": { - "name": "ResourcePrivileges", - "namespace": "security.has_privileges" - }, - "specLocation": "security/has_privileges/types.ts#L48-L48", - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Privileges", - "namespace": "security.has_privileges" - } - } - } - }, - { - "kind": "type_alias", - "name": { - "name": "Privileges", - "namespace": "security.has_privileges" - }, - "specLocation": "security/has_privileges/types.ts#L49-L49", - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - }, - { - "kind": "type_alias", - "name": { - "name": "ApiKeyAggregate", - "namespace": "security.query_api_keys" - }, - "specLocation": "security/query_api_keys/types.ts#L122-L139", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "CardinalityAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ValueCountAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "StringTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "LongTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DoubleTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "UnmappedTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "MultiTermsAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "MissingAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "FilterAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "FiltersAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "RangeAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "DateRangeAggregate", - "namespace": "_types.aggregations" - } - }, - { - "kind": "instance_of", - "type": { - "name": "CompositeAggregate", - "namespace": "_types.aggregations" - } - } - ], - "kind": "union_of" + "name": "PagerDutyContextType", + "namespace": "watcher._types" }, - "variants": { - "kind": "external_tag", - "nonExhaustive": true - } + "specLocation": "watcher/_types/Actions.ts#L67-L70" }, { "kind": "enum", "members": [ { - "name": "restart" + "name": "trigger" }, { - "name": "remove" + "name": "resolve" }, { - "name": "replace" + "name": "acknowledge" } ], "name": { - "name": "Type", - "namespace": "shutdown._types" + "name": "PagerDutyEventType", + "namespace": "watcher._types" }, - "specLocation": "shutdown/_types/types.ts#L20-L24" + "specLocation": "watcher/_types/Actions.ts#L72-L76" }, { "kind": "enum", "members": [ { - "name": "not_started" - }, - { - "name": "in_progress" - }, - { - "name": "stalled" + "name": "some" }, { - "name": "complete" + "name": "all" } ], "name": { - "name": "ShutdownStatus", - "namespace": "shutdown.get_node" + "name": "Quantifier", + "namespace": "watcher._types" }, - "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L45-L50" + "specLocation": "watcher/_types/Conditions.ts#L74-L77" }, { "kind": "enum", "members": [ { - "name": "remove" + "name": "json" }, { - "name": "restart" + "name": "yaml" + }, + { + "name": "text" } ], "name": { - "name": "ShutdownType", - "namespace": "shutdown.get_node" + "name": "ResponseContentType", + "namespace": "watcher._types" }, - "specLocation": "shutdown/get_node/ShutdownGetNodeResponse.ts#L40-L43" + "specLocation": "watcher/_types/Input.ts#L106-L110" }, { + "codegenNames": [ + "text", + "hour_minute" + ], + "description": "A time of day, expressed either as `hh:mm`, `noon`, `midnight`, or an hour/minutes structure.", "kind": "type_alias", "name": { - "name": "Repository", - "namespace": "snapshot._types" + "name": "ScheduleTimeOfDay", + "namespace": "watcher._types" }, - "specLocation": "snapshot/_types/SnapshotRepository.ts#L24-L34", + "specLocation": "watcher/_types/Schedule.ts#L99-L104", "type": { "items": [ { "kind": "instance_of", "type": { - "name": "AzureRepository", - "namespace": "snapshot._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "GcsRepository", - "namespace": "snapshot._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "S3Repository", - "namespace": "snapshot._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "SharedFileSystemRepository", - "namespace": "snapshot._types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "ReadOnlyUrlRepository", - "namespace": "snapshot._types" + "name": "string", + "namespace": "_builtins" } }, { "kind": "instance_of", "type": { - "name": "SourceOnlyRepository", - "namespace": "snapshot._types" + "name": "HourAndMinute", + "namespace": "watcher._types" } } ], "kind": "union_of" - }, - "variants": { - "kind": "internal_tag", - "nonExhaustive": true, - "tag": "type" } }, { - "inherits": { - "type": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - } - }, "kind": "interface", "name": { - "name": "AzureRepository", - "namespace": "snapshot._types" + "name": "HourAndMinute", + "namespace": "watcher._types" }, "properties": [ { - "description": "The Azure repository type.", - "extDocId": "repository-azure", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-azure.html", - "name": "type", + "name": "hour", "required": true, "type": { - "kind": "literal_value", - "value": "azure" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } }, { - "description": "The repository settings.", - "name": "settings", - "required": false, + "name": "minute", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "AzureRepositorySettings", - "namespace": "snapshot._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L40-L50" + "specLocation": "watcher/_types/Schedule.ts#L106-L109" }, { - "kind": "interface", - "name": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - }, - "properties": [ + "kind": "enum", + "members": [ { - "name": "uuid", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Uuid", - "namespace": "_types" - } - } + "aliases": [ + "all" + ], + "name": "_all" + }, + { + "name": "queued_watches" + }, + { + "name": "current_watches" + }, + { + "name": "pending_watches" } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L36-L38" - }, - { - "inherits": { - "type": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", "name": { - "name": "AzureRepositorySettings", - "namespace": "snapshot._types" + "name": "WatcherMetric", + "namespace": "watcher.stats" }, - "properties": [ + "specLocation": "watcher/stats/types.ts#L63-L69" + }, + { + "kind": "enum", + "members": [ { - "description": "The path to the repository data within the container.\nIt defaults to the root directory.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket.", - "name": "base_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "stopped" }, { - "description": "The name of the Azure repository client to use.", - "name": "client", - "required": false, - "serverDefault": "default", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "starting" }, { - "description": "The Azure container.", - "name": "container", - "required": false, - "serverDefault": "elasticsearch-snapshots", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "started" }, { - "description": "The maxmimum batch size, between 1 and 256, used for `BlobBatch` requests.\nDefaults to 256 which is the maximum number supported by the Azure blob batch API.", - "name": "delete_objects_max_size", - "required": false, - "serverDefault": 256, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, + "name": "stopping" + } + ], + "name": { + "name": "WatcherState", + "namespace": "watcher.stats" + }, + "specLocation": "watcher/stats/types.ts#L26-L31" + }, + { + "kind": "enum", + "members": [ { - "description": "Either `primary_only` or `secondary_only`.\nNote that if you set it to `secondary_only`, it will force `readonly` to `true`.", - "name": "location_mode", - "required": false, - "serverDefault": "primary_only", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "build" }, { - "description": "The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with `BlobBatch`.\nNote that the effective number of concurrent deletes is further limited by the Azure client connection and event loop thread limits.\nDefaults to 10, minimum is 1, maximum is 100.", - "name": "max_concurrent_batch_deletes", - "required": false, - "serverDefault": 10, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } + "name": "features" }, { - "description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", - "name": "readonly", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "name": "license" + } + ], + "name": { + "name": "XPackCategory", + "namespace": "xpack.info" + }, + "specLocation": "xpack/info/XPackInfoRequest.ts#L58-L62" + }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "behaviors": [ + { + "type": { + "name": "CommonQueryParameters", + "namespace": "_spec_utils" } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L145-L196" + "kind": "interface", + "name": { + "name": "RequestBase", + "namespace": "_types" + }, + "properties": [], + "specLocation": "_types/Base.ts#L34-L34" }, { + "description": "Implements a set of common query parameters all API's support.\nSince these can break the request structure these are listed explicitly as a behavior.\nIts up to individual clients to define support although `error_trace` and `pretty` are\nrecommended as a minimum.", "kind": "interface", "name": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" + "name": "CommonQueryParameters", + "namespace": "_spec_utils" }, "properties": [ { - "description": "Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type.", - "name": "chunk_size", + "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", + "name": "error_trace", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default.", - "name": "compress", + "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", + "name": "filter_path", "required": false, - "serverDefault": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" } }, { - "description": "The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings.", - "name": "max_restore_bytes_per_sec", + "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"eixsts_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", + "name": "human", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings.", - "name": "max_snapshot_bytes_per_sec", + "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", + "name": "pretty", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L116-L143" + "specLocation": "_spec_utils/behaviors.ts#L41-L75" }, { - "inherits": { - "type": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - } - }, "kind": "interface", "name": { - "name": "GcsRepository", - "namespace": "snapshot._types" + "name": "AcknowledgedResponseBase", + "namespace": "_types" }, "properties": [ { - "description": "The Google Cloud Storage repository type.", - "extDocId": "repository-gcs", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-gcs.html", - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "gcs" - } - }, - { - "description": "The repository settings.", - "name": "settings", + "description": "For a successful response, this value is always true. On failure, an exception is returned instead.", + "name": "acknowledged", "required": true, "type": { "kind": "instance_of", "type": { - "name": "GcsRepositorySettings", - "namespace": "snapshot._types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L52-L62" + "specLocation": "_types/Base.ts#L69-L72" }, { + "generics": [ + { + "name": "TDocument", + "namespace": "async_search._types.AsyncSearchDocumentResponseBase" + } + ], "inherits": { "type": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" + "name": "AsyncSearchResponseBase", + "namespace": "async_search._types" } }, "kind": "interface", "name": { - "name": "GcsRepositorySettings", - "namespace": "snapshot._types" + "name": "AsyncSearchDocumentResponseBase", + "namespace": "async_search._types" }, "properties": [ { - "description": "The name of the bucket to be used for snapshots.", - "name": "bucket", + "name": "response", "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "async_search._types.AsyncSearchDocumentResponseBase" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "AsyncSearch", + "namespace": "async_search._types" } } - }, + } + ], + "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L52-L56" + }, + { + "kind": "interface", + "name": { + "name": "AsyncSearchResponseBase", + "namespace": "async_search._types" + }, + "properties": [ { - "deprecation": { - "description": "", - "version": "6.3.0" - }, - "description": "The name used by the client when it uses the Google Cloud Storage service.", - "name": "application_name", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "description": "The path to the repository data within the bucket.\nIt defaults to the root of the bucket.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket.", - "name": "base_path", - "required": false, + "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`.", + "name": "is_partial", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "The name of the client to use to connect to Google Cloud Storage.", - "name": "client", - "required": false, - "serverDefault": "default", + "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`.", + "name": "is_running", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", - "name": "readonly", + "description": "Indicates when the async search will expire.", + "name": "expiration_time", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L198-L235" - }, - { - "inherits": { - "type": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "S3Repository", - "namespace": "snapshot._types" - }, - "properties": [ + }, { - "description": "The S3 repository type.", - "extDocId": "repository-s3", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html", - "name": "type", + "name": "expiration_time_in_millis", "required": true, "type": { - "kind": "literal_value", - "value": "s3" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } } }, { - "description": "The repository settings.\n\nNOTE: In addition to the specified settings, you can also use all non-secure client settings in the repository settings.\nIn this case, the client settings found in the repository settings will be merged with those of the named client used by the repository.\nConflicts between client and repository settings are resolved by the repository settings taking precedence over client settings.", - "name": "settings", - "required": true, + "name": "start_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "S3RepositorySettings", - "namespace": "snapshot._types" + "name": "DateTime", + "namespace": "_types" } } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L64-L78" - }, - { - "inherits": { - "type": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "S3RepositorySettings", - "namespace": "snapshot._types" - }, - "properties": [ + }, { - "description": "The name of the S3 bucket to use for snapshots.\nThe bucket name must adhere to Amazon's S3 bucket naming rules.", - "extDocId": "repository-s3-naming", - "extDocUrl": "https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules", - "name": "bucket", + "name": "start_time_in_millis", "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "EpochTime", + "namespace": "_types" } } }, { - "description": "The path to the repository data within its bucket.\nIt defaults to an empty string, meaning that the repository is at the root of the bucket.\nThe value of this setting should not start or end with a forward slash (`/`).\n\nNOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments may share the same bucket.", - "name": "base_path", + "description": "Indicates when the async search completed.\nIt is present only when the search has completed.", + "name": "completion_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "description": "The minimum threshold below which the chunk is uploaded using a single request.\nBeyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into several parts, each of `buffer_size` length, and to upload each part in its own request.\nNote that setting a buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result in upload errors.\nIt is also not possible to set a buffer size greater than 5gb as it is the maximum upload size allowed by S3.\nDefaults to `100mb` or 5% of JVM heap, whichever is smaller.", - "name": "buffer_size", + "name": "completion_time_in_millis", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "EpochTime", "namespace": "_types" } } - }, + } + ], + "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L24-L51" + }, + { + "generics": [ { - "description": "The S3 repository supports all S3 canned ACLs: `private`, `public-read`, `public-read-write`, `authenticated-read`, `log-delivery-write`, `bucket-owner-read`, `bucket-owner-full-control`.\nYou could specify a canned ACL using the `canned_acl` setting.\nWhen the S3 repository creates buckets and objects, it adds the canned ACL into the buckets and objects.", - "extDocId": "repository-s3-canned-acl", - "extDocUrl": "https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl", - "name": "canned_acl", + "name": "TDocument", + "namespace": "async_search._types.AsyncSearch" + } + ], + "kind": "interface", + "name": { + "name": "AsyncSearch", + "namespace": "async_search._types" + }, + "properties": [ + { + "description": "Partial aggregations results, coming from the shards that have already completed running the query.", + "name": "aggregations", "required": false, - "serverDefault": "private", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "AggregateName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Aggregate", + "namespace": "_types.aggregations" + } } } }, { - "description": "The name of the S3 client to use to connect to S3.", - "name": "client", + "name": "_clusters", "required": false, - "serverDefault": "default", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ClusterStatistics", + "namespace": "_types" } } }, { - "description": "The maxmimum batch size, between 1 and 1000, used for `DeleteObjects` requests.\nDefaults to 1000 which is the maximum number supported by the AWS DeleteObjects API.", - "extDocId": "repository-s3-delete-objects", - "extDocUrl": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html", - "name": "delete_objects_max_size", + "name": "fields", "required": false, - "serverDefault": 1000, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" } } }, { - "description": "The time to wait before trying again if an attempt to read a linearizable register fails.", - "name": "get_register_retry_delay", - "required": false, - "serverDefault": "5s", + "name": "hits", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "async_search._types.AsyncSearch" + } + } + ], "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "HitsMetadata", + "namespace": "_global.search._types" } } }, { - "description": "The maximum number of parts that Elasticsearch will write during a multipart upload of a single object.\nFiles which are larger than `buffer_size × max_multipart_parts` will be chunked into several smaller objects.\nElasticsearch may also split a file across multiple objects to satisfy other constraints such as the `chunk_size` limit.\nDefaults to `10000` which is the maximum number of parts in a multipart upload in AWS S3.", - "name": "max_multipart_parts", + "name": "max_score", "required": false, - "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "double", "namespace": "_types" } } }, { - "description": "The maximum number of possibly-dangling multipart uploads to clean up in each batch of snapshot deletions.\nDefaults to 1000 which is the maximum number supported by the AWS ListMultipartUploads API.\nIf set to `0`, Elasticsearch will not attempt to clean up dangling multipart uploads.", - "extDocId": "repository-s3-list-multipart", - "extDocUrl": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html", - "name": "max_multipart_upload_cleanup_size", + "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.", + "name": "num_reduce_phases", "required": false, - "serverDefault": 1000, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "description": "If true, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", - "name": "readonly", + "name": "profile", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Profile", + "namespace": "_global.search._types" } } }, { - "description": "When set to `true`, files are encrypted on server side using an AES256 algorithm.", - "name": "server_side_encryption", + "name": "pit_id", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "description": "The S3 storage class for objects written to the repository.\nValues may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`.", - "extDocId": "repository-s3-storage-classes", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html#repository-s3-storage-classes", - "name": "storage_class", + "name": "_scroll_id", "required": false, - "serverDefault": "standard", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ScrollId", + "namespace": "_types" } } }, { - "description": "The delay before the first retry and the amount the delay is incremented by on each subsequent retry.\nThe default is 50ms and the minimum is 0ms.", - "name": "throttled_delete_retry.delay_increment", - "required": false, - "serverDefault": "50ms", + "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.", + "name": "_shards", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "ShardStatistics", "namespace": "_types" } } }, { - "description": "The upper bound on how long the delays between retries will grow to.\nThe default is 5s and the minimum is 0ms.", - "name": "throttled_delete_retry.maximum_delay", + "name": "suggest", "required": false, - "serverDefault": "5s", "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "SuggestionName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "async_search._types.AsyncSearch" + } + } + ], + "kind": "instance_of", + "type": { + "name": "Suggest", + "namespace": "_global.search._types" + } + } } } }, { - "description": "The number times to retry a throttled snapshot deletion.\nThe default is 10 and the minimum value is 0 which will disable retries altogether.\nNote that if retries are enabled in the Azure client, each of these retries comprises that many client-level retries.", - "name": "throttled_delete_retry.maximum_number_of_retries", + "name": "terminated_early", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L237-L346" - }, - { - "inherits": { - "type": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - } - }, - "kind": "interface", - "name": { - "name": "SharedFileSystemRepository", - "namespace": "snapshot._types" - }, - "properties": [ + }, { - "description": "The shared file system repository type.", - "extDocId": "repository-shared-fs", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-filesystem-repository.html", - "name": "type", + "name": "timed_out", "required": true, "type": { - "kind": "literal_value", - "value": "fs" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } }, { - "description": "The repository settings.", - "name": "settings", + "name": "took", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SharedFileSystemRepositorySettings", - "namespace": "snapshot._types" + "name": "long", + "namespace": "_types" } } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L80-L90" + "specLocation": "async_search/_types/AsyncSearch.ts#L30-L56" }, { "inherits": { "type": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" + "name": "AsyncSearchResponseBase", + "namespace": "async_search._types" } }, "kind": "interface", "name": { - "name": "SharedFileSystemRepositorySettings", - "namespace": "snapshot._types" + "name": "StatusResponseBase", + "namespace": "async_search.status" }, "properties": [ { - "description": "The location of the shared filesystem used to store and retrieve snapshots.\nThis location must be registered in the `path.repo` setting on all master and data nodes in the cluster.\nUnlike `path.repo`, this setting supports only a single file path.", - "name": "location", + "description": "The number of shards that have run the query so far.", + "name": "_shards", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ShardStatistics", + "namespace": "_types" } } }, { - "description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.", - "name": "max_number_of_snapshots", + "description": "Metadata about clusters involved in the cross-cluster search.\nIt is not shown for local-only searches.", + "name": "_clusters", "required": false, - "serverDefault": 2147483647, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "ClusterStatistics", "namespace": "_types" } } }, { - "description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", - "name": "readonly", + "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.", + "name": "completion_status", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L348-L375" + "specLocation": "async_search/status/AsyncSearchStatusResponse.ts#L24-L38" }, { - "inherits": { - "type": { - "name": "RepositoryBase", - "namespace": "snapshot._types" - } - }, "kind": "interface", "name": { - "name": "ReadOnlyUrlRepository", - "namespace": "snapshot._types" + "name": "SlicedScroll", + "namespace": "_types" }, "properties": [ { - "description": "The read-only URL repository type.", - "extDocId": "repository-read-only", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-read-only-repository.html", - "name": "type", + "name": "field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "name": "id", "required": true, "type": { - "kind": "literal_value", - "value": "url" + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } } }, { - "description": "The repository settings.", - "name": "settings", + "name": "max", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ReadOnlyUrlRepositorySettings", - "namespace": "snapshot._types" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L92-L102" + "specLocation": "_types/SlicedScroll.ts#L23-L27" }, { - "inherits": { - "type": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" - } - }, "kind": "interface", "name": { - "name": "ReadOnlyUrlRepositorySettings", - "namespace": "snapshot._types" + "name": "OperationContainer", + "namespace": "_global.bulk" }, "properties": [ { - "description": "The maximum number of retries for HTTP and HTTPS URLs.", - "name": "http_max_retries", + "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.", + "name": "index", "required": false, - "serverDefault": 5, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IndexOperation", + "namespace": "_global.bulk" } } }, { - "description": "The maximum wait time for data transfers over a connection.", - "name": "http_socket_timeout", + "description": "Index the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.", + "name": "create", "required": false, - "serverDefault": "50s", "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "CreateOperation", + "namespace": "_global.bulk" } } }, { - "description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.", - "name": "max_number_of_snapshots", + "description": "Perform a partial document update.\nThe following line must contain the partial document and update options.", + "name": "update", "required": false, - "serverDefault": 2147483647, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "UpdateOperation", + "namespace": "_global.bulk" } } }, { - "description": "The URL location of the root of the shared filesystem repository.\nThe following protocols are supported:\n\n* `file`\n* `ftp`\n* `http`\n* `https`\n* `jar`\n\nURLs using the HTTP, HTTPS, or FTP protocols must be explicitly allowed with the `repositories.url.allowed_urls` cluster setting.\nThis setting supports wildcards in the place of a host, path, query, or fragment in the URL.\n\nURLs using the file protocol must point to the location of a shared filesystem accessible to all master and data nodes in the cluster.\nThis location must be registered in the `path.repo` setting.\nYou don't need to register URLs using the FTP, HTTP, HTTPS, or JAR protocols in the `path.repo` setting.", - "name": "url", - "required": true, + "description": "Remove the specified document from the index.", + "name": "delete", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DeleteOperation", + "namespace": "_global.bulk" } } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L377-L412" + "specLocation": "_global/bulk/types.ts#L158-L180", + "variants": { + "kind": "container" + } }, { "inherits": { "type": { - "name": "RepositoryBase", - "namespace": "snapshot._types" + "name": "WriteOperation", + "namespace": "_global.bulk" } }, "kind": "interface", "name": { - "name": "SourceOnlyRepository", - "namespace": "snapshot._types" + "name": "IndexOperation", + "namespace": "_global.bulk" }, - "properties": [ - { - "description": "The source-only repository type.", - "extDocId": "repository-source-only", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-source-only-repository.html", - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "source" - } - }, - { - "description": "The repository settings.", - "name": "settings", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SourceOnlyRepositorySettings", - "namespace": "snapshot._types" - } - } - } - ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L104-L114" + "properties": [], + "specLocation": "_global/bulk/types.ts#L142-L142" }, { "inherits": { "type": { - "name": "RepositorySettingsBase", - "namespace": "snapshot._types" + "name": "OperationBase", + "namespace": "_global.bulk" } }, "kind": "interface", "name": { - "name": "SourceOnlyRepositorySettings", - "namespace": "snapshot._types" + "name": "WriteOperation", + "namespace": "_global.bulk" }, "properties": [ { - "description": "The delegated repository type. For valid values, refer to the `type` parameter.\nSource repositories can use `settings` properties for its delegated repository type.", - "name": "delegate_type", + "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.", + "name": "dynamic_templates", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.", - "name": "max_number_of_snapshots", + "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.", + "name": "pipeline", "required": false, - "serverDefault": 2147483647, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "readonly" - ], - "description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", - "name": "read_only", + "description": "If `true`, the request's actions must target an index alias.", + "name": "require_alias", "required": false, "serverDefault": false, "type": { @@ -103275,235 +107151,216 @@ } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L414-L441" + "specLocation": "_global/bulk/types.ts#L119-L138" }, { - "kind": "enum", - "members": [ - { - "description": "The number of shards in the snapshot that were successfully stored in the repository.", - "name": "DONE" - }, - { - "description": "The number of shards in the snapshot that were not successfully stored in the repository.", - "name": "FAILURE" - }, - { - "description": "The number of shards in the snapshot that are in the finalizing stage of being stored in the repository.", - "name": "FINALIZE" - }, - { - "description": "The number of shards in the snapshot that are in the initializing stage of being stored in the repository.", - "name": "INIT" - }, - { - "description": "The number of shards in the snapshot that are in the started stage of being stored in the repository.", - "name": "STARTED" - } - ], + "kind": "interface", "name": { - "name": "ShardsStatsStage", - "namespace": "snapshot._types" + "name": "OperationBase", + "namespace": "_global.bulk" }, - "specLocation": "snapshot/_types/SnapshotShardsStatsStage.ts#L20-L31" - }, - { - "kind": "enum", - "members": [ + "properties": [ { - "name": "start_time" + "description": "The document ID.", + "name": "_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } }, { - "name": "duration" + "description": "The name of the index or index alias to perform the action on.", + "name": "_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } }, { - "name": "name" + "description": "A custom value used to route operations to a specific shard.", + "name": "routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" + } + } }, { - "name": "index_count" + "name": "if_primary_term", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" + "name": "if_seq_no", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SequenceNumber", + "namespace": "_types" } - }, - "name": "repository" + } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" + "name": "version", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" } - }, - "name": "shard_count" + } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" + "name": "version_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionType", + "namespace": "_types" } - }, - "name": "failed_shard_count" + } } ], - "name": { - "name": "SnapshotSort", - "namespace": "snapshot._types" - }, - "specLocation": "snapshot/_types/SnapshotInfo.ts#L73-L93" + "specLocation": "_global/bulk/types.ts#L100-L117" }, { - "kind": "type_alias", + "inherits": { + "type": { + "name": "WriteOperation", + "namespace": "_global.bulk" + } + }, + "kind": "interface", "name": { - "name": "Row", - "namespace": "sql._types" + "name": "CreateOperation", + "namespace": "_global.bulk" }, - "specLocation": "sql/_types/types.ts#L28-L28", - "type": { - "kind": "array_of", - "value": { - "kind": "user_defined_value" - } - } + "properties": [], + "specLocation": "_global/bulk/types.ts#L140-L140" }, { - "kind": "enum", - "members": [ - { - "name": "csv" - }, - { - "name": "json" - }, - { - "name": "tsv" - }, - { - "name": "txt" - }, - { - "name": "yaml" - }, + "inherits": { + "type": { + "name": "OperationBase", + "namespace": "_global.bulk" + } + }, + "kind": "interface", + "name": { + "name": "UpdateOperation", + "namespace": "_global.bulk" + }, + "properties": [ { - "name": "cbor" + "description": "If `true`, the request's actions must target an index alias.", + "name": "require_alias", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "name": "smile" + "description": "The number of times an update should be retried in the case of a version conflict.", + "name": "retry_on_conflict", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } } ], - "name": { - "name": "SqlFormat", - "namespace": "sql.query" - }, - "specLocation": "sql/query/QuerySqlRequest.ts#L154-L162" + "specLocation": "_global/bulk/types.ts#L146-L156" }, { - "kind": "type_alias", - "name": { - "name": "SynonymString", - "namespace": "synonyms._types" - }, - "specLocation": "synonyms/_types/SynonymRule.ts#L23-L23", - "type": { - "kind": "instance_of", + "inherits": { "type": { - "name": "string", - "namespace": "_builtins" + "name": "OperationBase", + "namespace": "_global.bulk" } - } + }, + "kind": "interface", + "name": { + "name": "DeleteOperation", + "namespace": "_global.bulk" + }, + "properties": [], + "specLocation": "_global/bulk/types.ts#L144-L144" }, { - "kind": "enum", - "members": [ - { - "description": "Group tasks by node ID.", - "name": "nodes" - }, + "generics": [ { - "description": "Group tasks by parent task ID.", - "name": "parents" + "name": "TDocument", + "namespace": "_global.bulk.UpdateAction" }, { - "description": "Do not group tasks.", - "name": "none" + "name": "TPartialDocument", + "namespace": "_global.bulk.UpdateAction" } ], - "name": { - "name": "GroupBy", - "namespace": "tasks._types" - }, - "specLocation": "tasks/_types/GroupBy.ts#L20-L27" - }, - { - "codegenNames": [ - "flat", - "grouped" - ], - "kind": "type_alias", - "name": { - "name": "TaskInfos", - "namespace": "tasks._types" - }, - "specLocation": "tasks/_types/TaskListResponseBase.ts#L40-L43", - "type": { - "items": [ - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TaskInfo", - "namespace": "tasks._types" - } - } - }, - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ParentTaskInfo", - "namespace": "tasks._types" - } - } - } - ], - "kind": "union_of" - } - }, - { "kind": "interface", "name": { - "name": "TaskInfo", - "namespace": "tasks._types" + "name": "UpdateAction", + "namespace": "_global.bulk" }, "properties": [ { - "name": "action", - "required": true, + "description": "If true, the `result` in the response is set to 'noop' when no changes to the document occur.", + "name": "detect_noop", + "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "cancelled", + "description": "A partial update to an existing document.", + "name": "doc", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TPartialDocument", + "namespace": "_global.bulk.UpdateAction" + } + } + }, + { + "description": "Set to `true` to use the contents of `doc` as the value of `upsert`.", + "name": "doc_as_upsert", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -103513,8 +107370,22 @@ } }, { - "name": "cancellable", - "required": true, + "description": "The script to run to update the document.", + "name": "script", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Script", + "namespace": "_types" + } + } + }, + { + "description": "Set to `true` to run the script whether or not the document exists.", + "name": "scripted_upsert", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -103524,455 +107395,498 @@ } }, { - "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.", - "name": "description", + "description": "If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.", + "name": "_source", "required": false, + "serverDefault": "true", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SourceConfig", + "namespace": "_global.search._types" } } }, { - "name": "headers", - "required": true, + "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.", + "name": "upsert", + "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_global.bulk.UpdateAction" + } + } + } + ], + "specLocation": "_global/bulk/types.ts#L182-L217" + }, + { + "kind": "interface", + "name": { + "name": "ResponseItem", + "namespace": "_global.bulk" + }, + "properties": [ + { + "description": "The document ID associated with the operation.", + "name": "_id", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } } + ], + "kind": "union_of" + } + }, + { + "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.", + "name": "_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "id", + "description": "The HTTP status code returned for the operation.", + "name": "status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "integer", "namespace": "_types" } } }, { - "name": "node", - "required": true, + "name": "failure_store", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", + "name": "FailureStoreStatus", + "namespace": "_global.bulk" + } + } + }, + { + "description": "Additional information about the failed operation.\nThe property is returned only for failed operations.", + "name": "error", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ErrorCause", "namespace": "_types" } } }, { - "name": "running_time", + "description": "The primary term assigned to the document for the operation.\nThis property is returned only for successful operations.", + "name": "_primary_term", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } }, { - "name": "running_time_in_nanos", - "required": true, + "description": "The result of the operation.\nSuccessful values are `created`, `deleted`, and `updated`.", + "name": "result", + "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "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.", + "name": "_seq_no", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SequenceNumber", "namespace": "_types" } } }, { - "name": "start_time_in_millis", - "required": true, + "description": "Shard information for the operation.", + "name": "_shards", + "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "EpochTime", + "name": "ShardStatistics", "namespace": "_types" } } }, { - "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.", - "name": "status", + "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.", + "name": "_version", "required": false, "type": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } } }, { - "name": "type", - "required": true, + "name": "forced_refresh", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "parent_task_id", + "name": "get", "required": false, "type": { + "generics": [ + { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + ], "kind": "instance_of", "type": { - "name": "TaskId", + "name": "InlineGet", "namespace": "_types" } } } ], - "specLocation": "tasks/_types/TaskInfo.ts#L32-L58" + "specLocation": "_global/bulk/types.ts#L37-L84" }, { - "inherits": { - "type": { - "name": "TaskInfo", - "namespace": "tasks._types" - } - }, - "kind": "interface", - "name": { - "name": "ParentTaskInfo", - "namespace": "tasks._types" - }, - "properties": [ + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ { - "name": "children", - "required": false, - "type": { - "kind": "array_of", - "value": { + "generics": [ + { "kind": "instance_of", "type": { - "name": "TaskInfo", - "namespace": "tasks._types" + "name": "string", + "namespace": "_builtins" } + }, + { + "kind": "user_defined_value" } + ], + "meta": { + "description": "Document metadata", + "fieldname": "metadata" + }, + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" } } ], - "specLocation": "tasks/_types/TaskListResponseBase.ts#L45-L47" - }, - { - "kind": "enum", - "members": [ - { - "name": "disabled" - }, + "generics": [ { - "name": "v1" + "name": "TDocument", + "namespace": "_types.InlineGet" } ], + "kind": "interface", "name": { - "name": "EcsCompatibilityType", - "namespace": "text_structure._types" + "name": "InlineGet", + "namespace": "_types" }, - "specLocation": "text_structure/_types/Structure.ts#L40-L43" - }, - { - "kind": "enum", - "members": [ + "properties": [ { - "name": "delimited" + "name": "fields", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } }, { - "name": "ndjson" + "name": "found", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } }, { - "name": "semi_structured_text" + "name": "_seq_no", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SequenceNumber", + "namespace": "_types" + } + } }, { - "name": "xml" - } - ], - "name": { - "name": "FormatType", - "namespace": "text_structure._types" - }, - "specLocation": "text_structure/_types/Structure.ts#L45-L50" - }, - { - "kind": "enum", - "members": [ - { - "name": "awaits_successful_execution" + "name": "_primary_term", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } }, { - "name": "ackable" + "name": "_routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" + } + } }, { - "name": "acked" + "name": "_source", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TDocument", + "namespace": "_types.InlineGet" + } + } } ], - "name": { - "name": "AcknowledgementOptions", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Action.ts#L103-L107" + "specLocation": "_types/common.ts#L317-L330" }, { - "kind": "enum", - "members": [ - { - "description": "The action execution is simulated. Each action type defines its own simulation operation mode. For example, the email action creates the email that would have been sent but does not actually send it. In this mode, the action might be throttled if the current state of the watch indicates it should be.", - "name": "simulate" - }, - { - "description": "Similar to the `simulate` mode, except the action is not throttled even if the current state of the watch indicates it should be.", - "name": "force_simulate" - }, - { - "description": "Executes the action as it would have been executed if the watch had been triggered by its own trigger. The execution might be throttled if the current state of the watch indicates it should be.", - "name": "execute" - }, - { - "description": "Similar to the `execute` mode, except the action is not throttled even if the current state of the watch indicates it should be.", - "name": "force_execute" - }, - { - "description": "The action is skipped and is not executed or simulated. Effectively forces the action to be throttled.", - "name": "skip" - } + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" ], - "name": { - "name": "ActionExecutionMode", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Action.ts#L67-L88" - }, - { - "kind": "enum", - "members": [ - { - "name": "success" - }, - { - "name": "failure" - }, - { - "name": "simulated" - }, + "behaviors": [ { - "name": "throttled" + "type": { + "name": "CommonCatQueryParameters", + "namespace": "_spec_utils" + } } ], - "name": { - "name": "ActionStatusOptions", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Action.ts#L96-L101" - }, - { - "kind": "enum", - "members": [ - { - "name": "email" - }, - { - "name": "webhook" - }, - { - "name": "index" - }, - { - "name": "logging" - }, - { - "name": "slack" - }, - { - "name": "pagerduty" + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" } - ], - "name": { - "name": "ActionType", - "namespace": "watcher._types" }, - "specLocation": "watcher/_types/Action.ts#L58-L65" - }, - { - "kind": "type_alias", + "kind": "interface", "name": { - "name": "Actions", - "namespace": "watcher._types" + "name": "CatRequestBase", + "namespace": "cat._types" }, - "specLocation": "watcher/_types/Action.ts#L56-L56", - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ActionStatus", - "namespace": "watcher._types" - } - } - } + "properties": [], + "specLocation": "cat/_types/CatBase.ts#L28-L30" }, { + "description": "Implements a set of common query parameters all Cat API's support.\nSince these can break the request structure these are listed explicitly as a behavior.", "kind": "interface", "name": { - "name": "ActionStatus", - "namespace": "watcher._types" + "name": "CommonCatQueryParameters", + "namespace": "_spec_utils" }, "properties": [ { - "name": "ack", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "AcknowledgeState", - "namespace": "watcher._types" - } - } - }, - { - "name": "last_execution", + "description": "Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.", + "name": "format", "required": false, + "serverDefault": "text", "type": { "kind": "instance_of", - "type": { - "name": "ExecutionState", - "namespace": "watcher._types" + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "last_successful_execution", + "description": "When set to `true` will output available columns. This option\ncan't be combined with any other query string option.", + "name": "help", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "ExecutionState", - "namespace": "watcher._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "last_throttle", + "description": "When set to `true` will enable verbose output.", + "name": "v", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "ThrottleState", - "namespace": "watcher._types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "watcher/_types/Action.ts#L125-L130" + "specLocation": "_spec_utils/behaviors.ts#L77-L100" }, { "kind": "interface", "name": { - "name": "AcknowledgeState", - "namespace": "watcher._types" + "name": "AliasesRecord", + "namespace": "cat.aliases" }, "properties": [ { - "name": "state", - "required": true, + "aliases": [ + "a" + ], + "description": "alias name", + "name": "alias", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "AcknowledgementOptions", - "namespace": "watcher._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "timestamp", - "required": true, + "aliases": [ + "i", + "idx" + ], + "description": "index alias points to", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", + "name": "IndexName", "namespace": "_types" } } - } - ], - "specLocation": "watcher/_types/Action.ts#L109-L112" - }, - { - "kind": "interface", - "name": { - "name": "ExecutionState", - "namespace": "watcher._types" - }, - "properties": [ + }, { - "name": "successful", - "required": true, + "aliases": [ + "f", + "fi" + ], + "description": "filter", + "name": "filter", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "timestamp", - "required": true, + "aliases": [ + "ri", + "routingIndex" + ], + "description": "index routing", + "name": "routing.index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "reason", + "aliases": [ + "rs", + "routingSearch" + ], + "description": "search routing", + "name": "routing.search", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "aliases": [ + "w", + "isWriteIndex" + ], + "description": "write index", + "name": "is_write_index", "required": false, "type": { "kind": "instance_of", @@ -103983,17 +107897,17 @@ } } ], - "specLocation": "watcher/_types/Action.ts#L114-L118" + "specLocation": "cat/aliases/types.ts#L22-L53" }, { "kind": "interface", "name": { - "name": "ThrottleState", - "namespace": "watcher._types" + "name": "ComponentTemplate", + "namespace": "cat.component_templates" }, "properties": [ { - "name": "reason", + "name": "name", "required": true, "type": { "kind": "instance_of", @@ -104004,585 +107918,273 @@ } }, { - "name": "timestamp", + "name": "version", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } - } - ], - "specLocation": "watcher/_types/Action.ts#L120-L123" - }, - { - "kind": "enum", - "members": [ - { - "name": "not_eq" - }, - { - "name": "eq" - }, - { - "name": "lt" - }, - { - "name": "gt" - }, - { - "name": "lte" - }, - { - "name": "gte" - } - ], - "name": { - "name": "ConditionOp", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Conditions.ts#L41-L48" - }, - { - "kind": "enum", - "members": [ - { - "name": "always" - }, - { - "name": "never" - }, - { - "name": "script" - }, - { - "name": "compare" - }, - { - "name": "array_compare" - } - ], - "name": { - "name": "ConditionType", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Conditions.ts#L64-L70" - }, - { - "kind": "enum", - "members": [ - { - "name": "http" - }, - { - "name": "https" - } - ], - "name": { - "name": "ConnectionScheme", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Input.ts#L39-L42" - }, - { - "docId": "cron-expressions", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-cron-expressions", - "kind": "type_alias", - "name": { - "name": "CronExpression", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Schedule.ts#L27-L30", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "kind": "enum", - "members": [ - { - "name": "json" - }, - { - "name": "yaml" - } - ], - "name": { - "name": "DataAttachmentFormat", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Actions.ts#L187-L190" - }, - { - "kind": "enum", - "members": [ - { - "name": "sunday" - }, - { - "name": "monday" - }, - { - "name": "tuesday" - }, - { - "name": "wednesday" - }, - { - "name": "thursday" - }, - { - "name": "friday" - }, - { - "name": "saturday" - } - ], - "name": { - "name": "Day", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Schedule.ts#L37-L45" - }, - { - "kind": "enum", - "members": [ - { - "name": "lowest" - }, - { - "name": "low" - }, - { - "name": "normal" - }, - { - "name": "high" - }, - { - "name": "highest" - } - ], - "name": { - "name": "EmailPriority", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Actions.ts#L197-L203" - }, - { - "kind": "enum", - "members": [ - { - "name": "awaits_execution" - }, - { - "name": "started" - }, - { - "name": "input" - }, - { - "name": "condition" - }, - { - "name": "actions" - }, - { - "name": "watch_transform" - }, - { - "name": "aborted" - }, - { - "name": "finished" - } - ], - "name": { - "name": "ExecutionPhase", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Execution.ts#L49-L58" - }, - { - "kind": "enum", - "members": [ - { - "name": "awaits_execution" - }, - { - "name": "checking" - }, - { - "name": "execution_not_needed" - }, - { - "name": "throttled" - }, - { - "name": "executed" - }, - { - "name": "failed" - }, - { - "name": "deleted_while_queued" - }, - { - "name": "not_executed_already_queued" - } - ], - "name": { - "name": "ExecutionStatus", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Execution.ts#L38-L47" - }, - { - "kind": "enum", - "members": [ - { - "name": "head" - }, - { - "name": "get" - }, - { - "name": "post" - }, - { - "name": "put" - }, - { - "name": "delete" - } - ], - "name": { - "name": "HttpInputMethod", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Input.ts#L59-L65" - }, - { - "kind": "enum", - "members": [ - { - "name": "http" - }, - { - "name": "search" - }, - { - "name": "simple" - } - ], - "name": { - "name": "InputType", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Input.ts#L100-L104" - }, - { - "kind": "enum", - "members": [ - { - "name": "january" - }, - { - "name": "february" - }, - { - "name": "march" - }, - { - "name": "april" - }, - { - "name": "may" - }, - { - "name": "june" - }, - { - "name": "july" - }, - { - "name": "august" - }, - { - "name": "september" - }, - { - "name": "october" - }, - { - "name": "november" - }, - { - "name": "december" - } - ], - "name": { - "name": "Month", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Schedule.ts#L65-L78" - }, - { - "kind": "enum", - "members": [ - { - "name": "link" - }, - { - "name": "image" - } - ], - "name": { - "name": "PagerDutyContextType", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Actions.ts#L67-L70" - }, - { - "kind": "enum", - "members": [ - { - "name": "trigger" - }, - { - "name": "resolve" - }, - { - "name": "acknowledge" - } - ], - "name": { - "name": "PagerDutyEventType", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Actions.ts#L72-L76" - }, - { - "kind": "enum", - "members": [ - { - "name": "some" - }, - { - "name": "all" - } - ], - "name": { - "name": "Quantifier", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Conditions.ts#L74-L77" - }, - { - "kind": "enum", - "members": [ - { - "name": "json" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } }, { - "name": "yaml" + "name": "alias_count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "text" - } - ], - "name": { - "name": "ResponseContentType", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Input.ts#L106-L110" - }, - { - "codegenNames": [ - "text", - "hour_minute" - ], - "description": "A time of day, expressed either as `hh:mm`, `noon`, `midnight`, or an hour/minutes structure.", - "kind": "type_alias", - "name": { - "name": "ScheduleTimeOfDay", - "namespace": "watcher._types" - }, - "specLocation": "watcher/_types/Schedule.ts#L99-L104", - "type": { - "items": [ - { + "name": "mapping_count", + "required": true, + "type": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } - }, - { + } + }, + { + "name": "settings_count", + "required": true, + "type": { "kind": "instance_of", "type": { - "name": "HourAndMinute", - "namespace": "watcher._types" + "name": "string", + "namespace": "_builtins" } } - ], - "kind": "union_of" - } - }, - { - "kind": "interface", - "name": { - "name": "HourAndMinute", - "namespace": "watcher._types" - }, - "properties": [ + }, { - "name": "hour", + "name": "metadata_count", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "minute", + "name": "included_in", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "watcher/_types/Schedule.ts#L106-L109" + "specLocation": "cat/component_templates/types.ts#L20-L28" }, { - "kind": "enum", - "members": [ + "kind": "interface", + "name": { + "name": "CountRecord", + "namespace": "cat.count" + }, + "properties": [ { "aliases": [ - "all" + "t", + "time" ], - "name": "_all" - }, - { - "name": "queued_watches" + "description": "seconds since 1970-01-01 00:00:00", + "name": "epoch", + "required": false, + "type": { + "generics": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitSeconds", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "Stringified", + "namespace": "_spec_utils" + } + } }, { - "name": "current_watches" + "aliases": [ + "ts", + "hms", + "hhmmss" + ], + "description": "time in HH:MM:SS", + "name": "timestamp", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TimeOfDay", + "namespace": "_types" + } + } }, { - "name": "pending_watches" + "aliases": [ + "dc", + "docs.count", + "docsCount" + ], + "description": "the document count", + "name": "count", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "name": { - "name": "WatcherMetric", - "namespace": "watcher.stats" - }, - "specLocation": "watcher/stats/types.ts#L63-L69" + "specLocation": "cat/count/types.ts#L23-L39" }, { - "kind": "enum", - "members": [ - { - "name": "stopped" - }, + "kind": "interface", + "name": { + "name": "IndicesRecord", + "namespace": "cat.indices" + }, + "properties": [ { - "name": "starting" + "aliases": [ + "h" + ], + "description": "current health status", + "name": "health", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "started" + "aliases": [ + "s" + ], + "description": "open/close status", + "name": "status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "stopping" - } - ], - "name": { - "name": "WatcherState", - "namespace": "watcher.stats" - }, - "specLocation": "watcher/stats/types.ts#L26-L31" - }, - { - "kind": "enum", - "members": [ - { - "name": "build" + "aliases": [ + "i", + "idx" + ], + "description": "index name", + "name": "index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "features" + "aliases": [ + "id" + ], + "description": "index uuid", + "name": "uuid", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } }, { - "name": "license" - } - ], - "name": { - "name": "XPackCategory", - "namespace": "xpack.info" - }, - "specLocation": "xpack/info/XPackInfoRequest.ts#L58-L62" - }, - { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "behaviors": [ - { + "aliases": [ + "p", + "shards.primary", + "shardsPrimary" + ], + "description": "number of primary shards", + "name": "pri", + "required": false, "type": { - "name": "CommonQueryParameters", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - ], - "kind": "interface", - "name": { - "name": "RequestBase", - "namespace": "_types" - }, - "properties": [], - "specLocation": "_types/Base.ts#L34-L34" - }, - { - "description": "Implements a set of common query parameters all API's support.\nSince these can break the request structure these are listed explicitly as a behavior.\nIts up to individual clients to define support although `error_trace` and `pretty` are\nrecommended as a minimum.", - "kind": "interface", - "name": { - "name": "CommonQueryParameters", - "namespace": "_spec_utils" - }, - "properties": [ + }, { - "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", - "name": "error_trace", + "aliases": [ + "r", + "shards.replica", + "shardsReplica" + ], + "description": "number of replica shards", + "name": "rep", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", - "name": "filter_path", + "aliases": [ + "dc", + "docsCount" + ], + "description": "available docs", + "name": "docs.count", "required": false, "type": { "items": [ @@ -104594,13 +108196,10 @@ } }, { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" } } ], @@ -104608,671 +108207,604 @@ } }, { - "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"eixsts_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", - "name": "human", + "aliases": [ + "dd", + "docsDeleted" + ], + "description": "deleted docs", + "name": "docs.deleted", "required": false, - "serverDefault": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", - "name": "pretty", + "aliases": [ + "cd" + ], + "description": "index creation date (millisecond value)", + "name": "creation.date", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - } - ], - "specLocation": "_spec_utils/behaviors.ts#L41-L75" - }, - { - "kind": "interface", - "name": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - }, - "properties": [ + }, { - "description": "For a successful response, this value is always true. On failure, an exception is returned instead.", - "name": "acknowledged", - "required": true, + "aliases": [ + "cds" + ], + "description": "index creation date (as string)", + "name": "creation.date.string", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - } - ], - "specLocation": "_types/Base.ts#L69-L72" - }, - { - "generics": [ + }, { - "name": "TDocument", - "namespace": "async_search._types.AsyncSearchDocumentResponseBase" - } - ], - "inherits": { - "type": { - "name": "AsyncSearchResponseBase", - "namespace": "async_search._types" - } - }, - "kind": "interface", - "name": { - "name": "AsyncSearchDocumentResponseBase", - "namespace": "async_search._types" - }, - "properties": [ + "aliases": [ + "ss", + "storeSize" + ], + "description": "store size of primaries & replicas", + "name": "store.size", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, { - "name": "response", - "required": true, + "description": "store size of primaries", + "name": "pri.store.size", + "required": false, "type": { - "generics": [ + "items": [ { "kind": "instance_of", "type": { - "name": "TDocument", - "namespace": "async_search._types.AsyncSearchDocumentResponseBase" + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" } } ], - "kind": "instance_of", - "type": { - "name": "AsyncSearch", - "namespace": "async_search._types" - } + "kind": "union_of" } - } - ], - "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L52-L56" - }, - { - "kind": "interface", - "name": { - "name": "AsyncSearchResponseBase", - "namespace": "async_search._types" - }, - "properties": [ + }, + { + "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, + "stack": { + "since": "8.11.0", + "stability": "stable" + } + }, + "description": "total size of dataset (including the cache for partially mounted indices)", + "name": "dataset.size", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, { - "name": "id", + "aliases": [ + "cs", + "completionSize" + ], + "description": "size of completion", + "name": "completion.size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "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`.", - "name": "is_partial", - "required": true, + "description": "size of completion", + "name": "pri.completion.size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "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`.", - "name": "is_running", - "required": true, + "aliases": [ + "fm", + "fielddataMemory" + ], + "description": "used fielddata cache", + "name": "fielddata.memory_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "Indicates when the async search will expire.", - "name": "expiration_time", + "description": "used fielddata cache", + "name": "pri.fielddata.memory_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "expiration_time_in_millis", - "required": true, + "aliases": [ + "fe", + "fielddataEvictions" + ], + "description": "fielddata evictions", + "name": "fielddata.evictions", + "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "EpochTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "start_time", + "description": "fielddata evictions", + "name": "pri.fielddata.evictions", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "start_time_in_millis", - "required": true, + "aliases": [ + "qcm", + "queryCacheMemory" + ], + "description": "used query cache", + "name": "query_cache.memory_size", + "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "EpochTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Indicates when the async search completed.\nIt is present only when the search has completed.", - "name": "completion_time", + "description": "used query cache", + "name": "pri.query_cache.memory_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "completion_time_in_millis", + "aliases": [ + "qce", + "queryCacheEvictions" + ], + "description": "query cache evictions", + "name": "query_cache.evictions", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - } - ], - "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L24-L51" - }, - { - "generics": [ - { - "name": "TDocument", - "namespace": "async_search._types.AsyncSearch" - } - ], - "kind": "interface", - "name": { - "name": "AsyncSearch", - "namespace": "async_search._types" - }, - "properties": [ - { - "description": "Partial aggregations results, coming from the shards that have already completed running the query.", - "name": "aggregations", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "AggregateName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Aggregate", - "namespace": "_types.aggregations" - } + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_clusters", + "description": "query cache evictions", + "name": "pri.query_cache.evictions", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterStatistics", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "fields", + "aliases": [ + "rcm", + "requestCacheMemory" + ], + "description": "used request cache", + "name": "request_cache.memory_size", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "hits", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "async_search._types.AsyncSearch" - } - } - ], "kind": "instance_of", "type": { - "name": "HitsMetadata", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_score", + "description": "used request cache", + "name": "pri.request_cache.memory_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "num_reduce_phases", + "aliases": [ + "rce", + "requestCacheEvictions" + ], + "description": "request cache evictions", + "name": "request_cache.evictions", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "profile", + "description": "request cache evictions", + "name": "pri.request_cache.evictions", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Profile", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "pit_id", + "aliases": [ + "rchc", + "requestCacheHitCount" + ], + "description": "request cache hit count", + "name": "request_cache.hit_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_scroll_id", + "description": "request cache hit count", + "name": "pri.request_cache.hit_count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ScrollId", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "_shards", - "required": true, + "aliases": [ + "rcmc", + "requestCacheMissCount" + ], + "description": "request cache miss count", + "name": "request_cache.miss_count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "suggest", + "description": "request cache miss count", + "name": "pri.request_cache.miss_count", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "SuggestionName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TDocument", - "namespace": "async_search._types.AsyncSearch" - } - } - ], - "kind": "instance_of", - "type": { - "name": "Suggest", - "namespace": "_global.search._types" - } - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "terminated_early", + "aliases": [ + "ft", + "flushTotal" + ], + "description": "number of flushes", + "name": "flush.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "timed_out", - "required": true, + "description": "number of flushes", + "name": "pri.flush.total", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "took", - "required": true, + "aliases": [ + "ftt", + "flushTotalTime" + ], + "description": "time spent in flush", + "name": "flush.total_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "async_search/_types/AsyncSearch.ts#L30-L56" - }, - { - "inherits": { - "type": { - "name": "AsyncSearchResponseBase", - "namespace": "async_search._types" - } - }, - "kind": "interface", - "name": { - "name": "StatusResponseBase", - "namespace": "async_search.status" - }, - "properties": [ + }, { - "description": "The number of shards that have run the query so far.", - "name": "_shards", - "required": true, + "description": "time spent in flush", + "name": "pri.flush.total_time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Metadata about clusters involved in the cross-cluster search.\nIt is not shown for local-only searches.", - "name": "_clusters", + "aliases": [ + "gc", + "getCurrent" + ], + "description": "number of current get ops", + "name": "get.current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ClusterStatistics", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "completion_status", + "description": "number of current get ops", + "name": "pri.get.current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "async_search/status/AsyncSearchStatusResponse.ts#L24-L38" - }, - { - "kind": "interface", - "name": { - "name": "SlicedScroll", - "namespace": "_types" - }, - "properties": [ + }, { - "name": "field", + "aliases": [ + "gti", + "getTime" + ], + "description": "time spent in get", + "name": "get.time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "id", - "required": true, + "description": "time spent in get", + "name": "pri.get.time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max", - "required": true, + "aliases": [ + "gto", + "getTotal" + ], + "description": "number of get ops", + "name": "get.total", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/SlicedScroll.ts#L23-L27" - }, - { - "kind": "interface", - "name": { - "name": "OperationContainer", - "namespace": "_global.bulk" - }, - "properties": [ + }, { - "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.", - "name": "index", + "description": "number of get ops", + "name": "pri.get.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexOperation", - "namespace": "_global.bulk" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Index the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.", - "name": "create", + "aliases": [ + "geti", + "getExistsTime" + ], + "description": "time spent in successful gets", + "name": "get.exists_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CreateOperation", - "namespace": "_global.bulk" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Perform a partial document update.\nThe following line must contain the partial document and update options.", - "name": "update", + "description": "time spent in successful gets", + "name": "pri.get.exists_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "UpdateOperation", - "namespace": "_global.bulk" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Remove the specified document from the index.", - "name": "delete", + "aliases": [ + "geto", + "getExistsTotal" + ], + "description": "number of successful gets", + "name": "get.exists_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DeleteOperation", - "namespace": "_global.bulk" + "name": "string", + "namespace": "_builtins" } - } - } - ], - "specLocation": "_global/bulk/types.ts#L158-L180", - "variants": { - "kind": "container" - } - }, - { - "inherits": { - "type": { - "name": "WriteOperation", - "namespace": "_global.bulk" - } - }, - "kind": "interface", - "name": { - "name": "IndexOperation", - "namespace": "_global.bulk" - }, - "properties": [], - "specLocation": "_global/bulk/types.ts#L142-L142" - }, - { - "inherits": { - "type": { - "name": "OperationBase", - "namespace": "_global.bulk" - } - }, - "kind": "interface", - "name": { - "name": "WriteOperation", - "namespace": "_global.bulk" - }, - "properties": [ + } + }, { - "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.", - "name": "dynamic_templates", + "description": "number of successful gets", + "name": "pri.get.exists_total", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "pipeline", + "aliases": [ + "gmti", + "getMissingTime" + ], + "description": "time spent in failed gets", + "name": "get.missing_time", "required": false, "type": { "kind": "instance_of", @@ -105283,325 +108815,277 @@ } }, { - "description": "If `true`, the request's actions must target an index alias.", - "name": "require_alias", + "description": "time spent in failed gets", + "name": "pri.get.missing_time", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - } - ], - "specLocation": "_global/bulk/types.ts#L119-L138" - }, - { - "kind": "interface", - "name": { - "name": "OperationBase", - "namespace": "_global.bulk" - }, - "properties": [ + }, { - "description": "The document ID.", - "name": "_id", + "aliases": [ + "gmto", + "getMissingTotal" + ], + "description": "number of failed gets", + "name": "get.missing_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The name of the index or index alias to perform the action on.", - "name": "_index", + "description": "number of failed gets", + "name": "pri.get.missing_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "A custom value used to route operations to a specific shard.", - "name": "routing", + "aliases": [ + "idc", + "indexingDeleteCurrent" + ], + "description": "number of current deletions", + "name": "indexing.delete_current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "if_primary_term", + "description": "number of current deletions", + "name": "pri.indexing.delete_current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "if_seq_no", + "aliases": [ + "idti", + "indexingDeleteTime" + ], + "description": "time spent in deletions", + "name": "indexing.delete_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "version", + "description": "time spent in deletions", + "name": "pri.indexing.delete_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "version_type", + "aliases": [ + "idto", + "indexingDeleteTotal" + ], + "description": "number of delete ops", + "name": "indexing.delete_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionType", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_global/bulk/types.ts#L100-L117" - }, - { - "inherits": { - "type": { - "name": "WriteOperation", - "namespace": "_global.bulk" - } - }, - "kind": "interface", - "name": { - "name": "CreateOperation", - "namespace": "_global.bulk" - }, - "properties": [], - "specLocation": "_global/bulk/types.ts#L140-L140" - }, - { - "inherits": { - "type": { - "name": "OperationBase", - "namespace": "_global.bulk" - } - }, - "kind": "interface", - "name": { - "name": "UpdateOperation", - "namespace": "_global.bulk" - }, - "properties": [ + }, { - "description": "If `true`, the request's actions must target an index alias.", - "name": "require_alias", + "description": "number of delete ops", + "name": "pri.indexing.delete_total", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "The number of times an update should be retried in the case of a version conflict.", - "name": "retry_on_conflict", + "aliases": [ + "iic", + "indexingIndexCurrent" + ], + "description": "number of current indexing ops", + "name": "indexing.index_current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_global/bulk/types.ts#L146-L156" - }, - { - "inherits": { - "type": { - "name": "OperationBase", - "namespace": "_global.bulk" - } - }, - "kind": "interface", - "name": { - "name": "DeleteOperation", - "namespace": "_global.bulk" - }, - "properties": [], - "specLocation": "_global/bulk/types.ts#L144-L144" - }, - { - "generics": [ - { - "name": "TDocument", - "namespace": "_global.bulk.UpdateAction" }, { - "name": "TPartialDocument", - "namespace": "_global.bulk.UpdateAction" - } - ], - "kind": "interface", - "name": { - "name": "UpdateAction", - "namespace": "_global.bulk" - }, - "properties": [ + "description": "number of current indexing ops", + "name": "pri.indexing.index_current", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { - "description": "If true, the `result` in the response is set to 'noop' when no changes to the document occur.", - "name": "detect_noop", + "aliases": [ + "iiti", + "indexingIndexTime" + ], + "description": "time spent in indexing", + "name": "indexing.index_time", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "A partial update to an existing document.", - "name": "doc", + "description": "time spent in indexing", + "name": "pri.indexing.index_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TPartialDocument", - "namespace": "_global.bulk.UpdateAction" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Set to `true` to use the contents of `doc` as the value of `upsert`.", - "name": "doc_as_upsert", + "aliases": [ + "iito", + "indexingIndexTotal" + ], + "description": "number of indexing ops", + "name": "indexing.index_total", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "The script to run to update the document.", - "name": "script", + "description": "number of indexing ops", + "name": "pri.indexing.index_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Script", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Set to `true` to run the script whether or not the document exists.", - "name": "scripted_upsert", + "aliases": [ + "iif", + "indexingIndexFailed" + ], + "description": "number of failed indexing ops", + "name": "indexing.index_failed", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.", - "name": "_source", + "description": "number of failed indexing ops", + "name": "pri.indexing.index_failed", "required": false, - "serverDefault": "true", "type": { "kind": "instance_of", "type": { - "name": "SourceConfig", - "namespace": "_global.search._types" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "upsert", + "aliases": [ + "mc", + "mergesCurrent" + ], + "description": "number of current merges", + "name": "merges.current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TDocument", - "namespace": "_global.bulk.UpdateAction" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_global/bulk/types.ts#L182-L217" - }, - { - "kind": "interface", - "name": { - "name": "ResponseItem", - "namespace": "_global.bulk" - }, - "properties": [ + }, { - "description": "The document ID associated with the operation.", - "name": "_id", + "description": "number of current merges", + "name": "pri.merges.current", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "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.", - "name": "_index", - "required": true, + "aliases": [ + "mcd", + "mergesCurrentDocs" + ], + "description": "number of current merging docs", + "name": "merges.current_docs", + "required": false, "type": { "kind": "instance_of", "type": { @@ -105611,55 +109095,64 @@ } }, { - "description": "The HTTP status code returned for the operation.", - "name": "status", - "required": true, + "description": "number of current merging docs", + "name": "pri.merges.current_docs", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "failure_store", + "aliases": [ + "mcs", + "mergesCurrentSize" + ], + "description": "size of current merges", + "name": "merges.current_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FailureStoreStatus", - "namespace": "_global.bulk" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Additional information about the failed operation.\nThe property is returned only for failed operations.", - "name": "error", + "description": "size of current merges", + "name": "pri.merges.current_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ErrorCause", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The primary term assigned to the document for the operation.\nThis property is returned only for successful operations.", - "name": "_primary_term", + "aliases": [ + "mt", + "mergesTotal" + ], + "description": "number of completed merge ops", + "name": "merges.total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The result of the operation.\nSuccessful values are `created`, `deleted`, and `updated`.", - "name": "result", + "description": "number of completed merge ops", + "name": "pri.merges.total", "required": false, "type": { "kind": "instance_of", @@ -105670,238 +109163,219 @@ } }, { - "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.", - "name": "_seq_no", + "aliases": [ + "mtd", + "mergesTotalDocs" + ], + "description": "docs merged", + "name": "merges.total_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Shard information for the operation.", - "name": "_shards", + "description": "docs merged", + "name": "pri.merges.total_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "_version", + "aliases": [ + "mts", + "mergesTotalSize" + ], + "description": "size merged", + "name": "merges.total_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "forced_refresh", + "description": "size merged", + "name": "pri.merges.total_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "get", + "aliases": [ + "mtt", + "mergesTotalTime" + ], + "description": "time spent in merges", + "name": "merges.total_time", "required": false, "type": { - "generics": [ - { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - ], "kind": "instance_of", "type": { - "name": "InlineGet", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_global/bulk/types.ts#L37-L84" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ + }, { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "user_defined_value" + "description": "time spent in merges", + "name": "pri.merges.total_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } + } + }, + { + "aliases": [ + "rto", + "refreshTotal" ], - "meta": { - "description": "Document metadata", - "fieldname": "metadata" - }, + "description": "total refreshes", + "name": "refresh.total", + "required": false, "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - ], - "generics": [ + }, { - "name": "TDocument", - "namespace": "_types.InlineGet" - } - ], - "kind": "interface", - "name": { - "name": "InlineGet", - "namespace": "_types" - }, - "properties": [ + "description": "total refreshes", + "name": "pri.refresh.total", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { - "name": "fields", + "aliases": [ + "rti", + "refreshTime" + ], + "description": "time spent in refreshes", + "name": "refresh.time", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "found", - "required": true, + "description": "time spent in refreshes", + "name": "pri.refresh.time", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "_seq_no", + "aliases": [ + "reto" + ], + "description": "total external refreshes", + "name": "refresh.external_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SequenceNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_primary_term", + "description": "total external refreshes", + "name": "pri.refresh.external_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_routing", + "aliases": [ + "reti" + ], + "description": "time spent in external refreshes", + "name": "refresh.external_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_source", + "description": "time spent in external refreshes", + "name": "pri.refresh.external_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TDocument", - "namespace": "_types.InlineGet" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "_types/common.ts#L317-L330" - }, - { - "attachedBehaviors": [ - "CommonCatQueryParameters", - "CommonQueryParameters" - ], - "behaviors": [ + }, { + "aliases": [ + "rli", + "refreshListeners" + ], + "description": "number of pending refresh listeners", + "name": "refresh.listeners", + "required": false, "type": { - "name": "CommonCatQueryParameters", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } - } - ], - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "kind": "interface", - "name": { - "name": "CatRequestBase", - "namespace": "cat._types" - }, - "properties": [], - "specLocation": "cat/_types/CatBase.ts#L28-L30" - }, - { - "description": "Implements a set of common query parameters all Cat API's support.\nSince these can break the request structure these are listed explicitly as a behavior.", - "kind": "interface", - "name": { - "name": "CommonCatQueryParameters", - "namespace": "_spec_utils" - }, - "properties": [ + }, { - "description": "Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.", - "name": "format", + "description": "number of pending refresh listeners", + "name": "pri.refresh.listeners", "required": false, - "serverDefault": "text", "type": { "kind": "instance_of", "type": { @@ -105911,47 +109385,40 @@ } }, { - "description": "When set to `true` will output available columns. This option\ncan't be combined with any other query string option.", - "name": "help", + "aliases": [ + "sfc", + "searchFetchCurrent" + ], + "description": "current fetch phase ops", + "name": "search.fetch_current", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "When set to `true` will enable verbose output.", - "name": "v", + "description": "current fetch phase ops", + "name": "pri.search.fetch_current", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - } - ], - "specLocation": "_spec_utils/behaviors.ts#L77-L100" - }, - { - "kind": "interface", - "name": { - "name": "AliasesRecord", - "namespace": "cat.aliases" - }, - "properties": [ + }, { "aliases": [ - "a" + "sfti", + "searchFetchTime" ], - "description": "alias name", - "name": "alias", + "description": "time spent in fetch phase", + "name": "search.fetch_time", "required": false, "type": { "kind": "instance_of", @@ -105962,28 +109429,24 @@ } }, { - "aliases": [ - "i", - "idx" - ], - "description": "index alias points to", - "name": "index", + "description": "time spent in fetch phase", + "name": "pri.search.fetch_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "f", - "fi" + "sfto", + "searchFetchTotal" ], - "description": "filter", - "name": "filter", + "description": "total fetch ops", + "name": "search.fetch_total", "required": false, "type": { "kind": "instance_of", @@ -105994,12 +109457,8 @@ } }, { - "aliases": [ - "ri", - "routingIndex" - ], - "description": "index routing", - "name": "routing.index", + "description": "total fetch ops", + "name": "pri.search.fetch_total", "required": false, "type": { "kind": "instance_of", @@ -106011,11 +109470,23 @@ }, { "aliases": [ - "rs", - "routingSearch" + "so", + "searchOpenContexts" ], - "description": "search routing", - "name": "routing.search", + "description": "open search contexts", + "name": "search.open_contexts", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "open search contexts", + "name": "pri.search.open_contexts", "required": false, "type": { "kind": "instance_of", @@ -106027,11 +109498,11 @@ }, { "aliases": [ - "w", - "isWriteIndex" + "sqc", + "searchQueryCurrent" ], - "description": "write index", - "name": "is_write_index", + "description": "current query phase ops", + "name": "search.query_current", "required": false, "type": { "kind": "instance_of", @@ -106040,20 +109511,11 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/aliases/types.ts#L22-L53" - }, - { - "kind": "interface", - "name": { - "name": "ComponentTemplate", - "namespace": "cat.component_templates" - }, - "properties": [ + }, { - "name": "name", - "required": true, + "description": "current query phase ops", + "name": "pri.search.query_current", + "required": false, "type": { "kind": "instance_of", "type": { @@ -106063,31 +109525,25 @@ } }, { - "name": "version", - "required": true, + "aliases": [ + "sqti", + "searchQueryTime" + ], + "description": "time spent in query phase", + "name": "search.query_time", + "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "name": "alias_count", - "required": true, + "description": "time spent in query phase", + "name": "pri.search.query_time", + "required": false, "type": { "kind": "instance_of", "type": { @@ -106097,8 +109553,13 @@ } }, { - "name": "mapping_count", - "required": true, + "aliases": [ + "sqto", + "searchQueryTotal" + ], + "description": "total query phase ops", + "name": "search.query_total", + "required": false, "type": { "kind": "instance_of", "type": { @@ -106108,8 +109569,9 @@ } }, { - "name": "settings_count", - "required": true, + "description": "total query phase ops", + "name": "pri.search.query_total", + "required": false, "type": { "kind": "instance_of", "type": { @@ -106119,8 +109581,13 @@ } }, { - "name": "metadata_count", - "required": true, + "aliases": [ + "scc", + "searchScrollCurrent" + ], + "description": "open scroll contexts", + "name": "search.scroll_current", + "required": false, "type": { "kind": "instance_of", "type": { @@ -106130,8 +109597,9 @@ } }, { - "name": "included_in", - "required": true, + "description": "open scroll contexts", + "name": "pri.search.scroll_current", + "required": false, "type": { "kind": "instance_of", "type": { @@ -106139,76 +109607,42 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/component_templates/types.ts#L20-L28" - }, - { - "kind": "interface", - "name": { - "name": "CountRecord", - "namespace": "cat.count" - }, - "properties": [ + }, { "aliases": [ - "t", - "time" + "scti", + "searchScrollTime" ], - "description": "seconds since 1970-01-01 00:00:00", - "name": "epoch", + "description": "time scroll contexts held open", + "name": "search.scroll_time", "required": false, "type": { - "generics": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitSeconds", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "string", + "namespace": "_builtins" } } }, { - "aliases": [ - "ts", - "hms", - "hhmmss" - ], - "description": "time in HH:MM:SS", - "name": "timestamp", + "description": "time scroll contexts held open", + "name": "pri.search.scroll_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TimeOfDay", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "dc", - "docs.count", - "docsCount" + "scto", + "searchScrollTotal" ], - "description": "the document count", - "name": "count", + "description": "completed scroll contexts", + "name": "search.scroll_total", "required": false, "type": { "kind": "instance_of", @@ -106217,23 +109651,10 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/count/types.ts#L23-L39" - }, - { - "kind": "interface", - "name": { - "name": "IndicesRecord", - "namespace": "cat.indices" - }, - "properties": [ + }, { - "aliases": [ - "h" - ], - "description": "current health status", - "name": "health", + "description": "completed scroll contexts", + "name": "pri.search.scroll_total", "required": false, "type": { "kind": "instance_of", @@ -106245,10 +109666,11 @@ }, { "aliases": [ - "s" + "sc", + "segmentsCount" ], - "description": "open/close status", - "name": "status", + "description": "number of segments", + "name": "segments.count", "required": false, "type": { "kind": "instance_of", @@ -106259,12 +109681,8 @@ } }, { - "aliases": [ - "i", - "idx" - ], - "description": "index name", - "name": "index", + "description": "number of segments", + "name": "pri.segments.count", "required": false, "type": { "kind": "instance_of", @@ -106276,10 +109694,11 @@ }, { "aliases": [ - "id" + "sm", + "segmentsMemory" ], - "description": "index uuid", - "name": "uuid", + "description": "memory used by segments", + "name": "segments.memory", "required": false, "type": { "kind": "instance_of", @@ -106290,13 +109709,8 @@ } }, { - "aliases": [ - "p", - "shards.primary", - "shardsPrimary" - ], - "description": "number of primary shards", - "name": "pri", + "description": "memory used by segments", + "name": "pri.segments.memory", "required": false, "type": { "kind": "instance_of", @@ -106308,12 +109722,23 @@ }, { "aliases": [ - "r", - "shards.replica", - "shardsReplica" + "siwm", + "segmentsIndexWriterMemory" ], - "description": "number of replica shards", - "name": "rep", + "description": "memory used by index writer", + "name": "segments.index_writer_memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "memory used by index writer", + "name": "pri.segments.index_writer_memory", "required": false, "type": { "kind": "instance_of", @@ -106325,66 +109750,67 @@ }, { "aliases": [ - "dc", - "docsCount" + "svmm", + "segmentsVersionMapMemory" ], - "description": "available docs", - "name": "docs.count", + "description": "memory used by version map", + "name": "segments.version_map_memory", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "memory used by version map", + "name": "pri.segments.version_map_memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { "aliases": [ - "dd", - "docsDeleted" + "sfbm", + "fixedBitsetMemory" ], - "description": "deleted docs", - "name": "docs.deleted", + "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", + "name": "segments.fixed_bitset_memory", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", + "name": "pri.segments.fixed_bitset_memory", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { "aliases": [ - "cd" + "wc", + "warmerCurrent" ], - "description": "index creation date (millisecond value)", - "name": "creation.date", + "description": "current warmer ops", + "name": "warmer.current", "required": false, "type": { "kind": "instance_of", @@ -106395,11 +109821,8 @@ } }, { - "aliases": [ - "cds" - ], - "description": "index creation date (as string)", - "name": "creation.date.string", + "description": "current warmer ops", + "name": "pri.warmer.current", "required": false, "type": { "kind": "instance_of", @@ -106411,97 +109834,67 @@ }, { "aliases": [ - "ss", - "storeSize" + "wto", + "warmerTotal" ], - "description": "store size of primaries & replicas", - "name": "store.size", + "description": "total warmer ops", + "name": "warmer.total", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "description": "store size of primaries", - "name": "pri.store.size", + "description": "total warmer ops", + "name": "pri.warmer.total", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, - "stack": { - "since": "8.11.0", - "stability": "stable" + "aliases": [ + "wtt", + "warmerTotalTime" + ], + "description": "time spent in warmers", + "name": "warmer.total_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - }, - "description": "total size of dataset (including the cache for partially mounted indices)", - "name": "dataset.size", + } + }, + { + "description": "time spent in warmers", + "name": "pri.warmer.total_time", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { "aliases": [ - "cs", - "completionSize" + "suc", + "suggestCurrent" ], - "description": "size of completion", - "name": "completion.size", + "description": "number of current suggest ops", + "name": "suggest.current", "required": false, "type": { "kind": "instance_of", @@ -106512,8 +109905,8 @@ } }, { - "description": "size of completion", - "name": "pri.completion.size", + "description": "number of current suggest ops", + "name": "pri.suggest.current", "required": false, "type": { "kind": "instance_of", @@ -106525,11 +109918,11 @@ }, { "aliases": [ - "fm", - "fielddataMemory" + "suti", + "suggestTime" ], - "description": "used fielddata cache", - "name": "fielddata.memory_size", + "description": "time spend in suggest", + "name": "suggest.time", "required": false, "type": { "kind": "instance_of", @@ -106540,8 +109933,8 @@ } }, { - "description": "used fielddata cache", - "name": "pri.fielddata.memory_size", + "description": "time spend in suggest", + "name": "pri.suggest.time", "required": false, "type": { "kind": "instance_of", @@ -106553,11 +109946,11 @@ }, { "aliases": [ - "fe", - "fielddataEvictions" + "suto", + "suggestTotal" ], - "description": "fielddata evictions", - "name": "fielddata.evictions", + "description": "number of suggest ops", + "name": "suggest.total", "required": false, "type": { "kind": "instance_of", @@ -106568,8 +109961,8 @@ } }, { - "description": "fielddata evictions", - "name": "pri.fielddata.evictions", + "description": "number of suggest ops", + "name": "pri.suggest.total", "required": false, "type": { "kind": "instance_of", @@ -106581,11 +109974,11 @@ }, { "aliases": [ - "qcm", - "queryCacheMemory" + "tm", + "memoryTotal" ], - "description": "used query cache", - "name": "query_cache.memory_size", + "description": "total used memory", + "name": "memory.total", "required": false, "type": { "kind": "instance_of", @@ -106596,8 +109989,8 @@ } }, { - "description": "used query cache", - "name": "pri.query_cache.memory_size", + "description": "total user memory", + "name": "pri.memory.total", "required": false, "type": { "kind": "instance_of", @@ -106609,11 +110002,10 @@ }, { "aliases": [ - "qce", - "queryCacheEvictions" + "sth" ], - "description": "query cache evictions", - "name": "query_cache.evictions", + "description": "indicates if the index is search throttled", + "name": "search.throttled", "required": false, "type": { "kind": "instance_of", @@ -106624,8 +110016,24 @@ } }, { - "description": "query cache evictions", - "name": "pri.query_cache.evictions", + "aliases": [ + "bto", + "bulkTotalOperation" + ], + "description": "number of bulk shard ops", + "name": "bulk.total_operations", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "number of bulk shard ops", + "name": "pri.bulk.total_operations", "required": false, "type": { "kind": "instance_of", @@ -106637,11 +110045,11 @@ }, { "aliases": [ - "rcm", - "requestCacheMemory" + "btti", + "bulkTotalTime" ], - "description": "used request cache", - "name": "request_cache.memory_size", + "description": "time spend in shard bulk", + "name": "bulk.total_time", "required": false, "type": { "kind": "instance_of", @@ -106652,8 +110060,8 @@ } }, { - "description": "used request cache", - "name": "pri.request_cache.memory_size", + "description": "time spend in shard bulk", + "name": "pri.bulk.total_time", "required": false, "type": { "kind": "instance_of", @@ -106665,11 +110073,11 @@ }, { "aliases": [ - "rce", - "requestCacheEvictions" + "btsi", + "bulkTotalSizeInBytes" ], - "description": "request cache evictions", - "name": "request_cache.evictions", + "description": "total size in bytes of shard bulk", + "name": "bulk.total_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -106680,8 +110088,8 @@ } }, { - "description": "request cache evictions", - "name": "pri.request_cache.evictions", + "description": "total size in bytes of shard bulk", + "name": "pri.bulk.total_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -106693,11 +110101,11 @@ }, { "aliases": [ - "rchc", - "requestCacheHitCount" + "bati", + "bulkAvgTime" ], - "description": "request cache hit count", - "name": "request_cache.hit_count", + "description": "average time spend in shard bulk", + "name": "bulk.avg_time", "required": false, "type": { "kind": "instance_of", @@ -106708,8 +110116,8 @@ } }, { - "description": "request cache hit count", - "name": "pri.request_cache.hit_count", + "description": "average time spend in shard bulk", + "name": "pri.bulk.avg_time", "required": false, "type": { "kind": "instance_of", @@ -106721,11 +110129,11 @@ }, { "aliases": [ - "rcmc", - "requestCacheMissCount" + "basi", + "bulkAvgSizeInBytes" ], - "description": "request cache miss count", - "name": "request_cache.miss_count", + "description": "average size in bytes of shard bulk", + "name": "bulk.avg_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -106736,8 +110144,8 @@ } }, { - "description": "request cache miss count", - "name": "pri.request_cache.miss_count", + "description": "average size in bytes of shard bulk", + "name": "pri.bulk.avg_size_in_bytes", "required": false, "type": { "kind": "instance_of", @@ -106746,14 +110154,35 @@ "namespace": "_builtins" } } + } + ], + "specLocation": "cat/indices/types.ts#L20-L808" + }, + { + "kind": "interface", + "name": { + "name": "DataFrameAnalyticsRecord", + "namespace": "cat.ml_data_frame_analytics" + }, + "properties": [ + { + "description": "The identifier for the job.", + "name": "id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } }, { "aliases": [ - "ft", - "flushTotal" + "t" ], - "description": "number of flushes", - "name": "flush.total", + "description": "The type of analysis that the job performs.", + "name": "type", "required": false, "type": { "kind": "instance_of", @@ -106764,8 +110193,12 @@ } }, { - "description": "number of flushes", - "name": "pri.flush.total", + "aliases": [ + "ct", + "createTime" + ], + "description": "The time when the job was created.", + "name": "create_time", "required": false, "type": { "kind": "instance_of", @@ -106777,51 +110210,57 @@ }, { "aliases": [ - "ftt", - "flushTotalTime" + "v" ], - "description": "time spent in flush", - "name": "flush.total_time", + "description": "The version of Elasticsearch when the job was created.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } }, { - "description": "time spent in flush", - "name": "pri.flush.total_time", + "aliases": [ + "si", + "sourceIndex" + ], + "description": "The name of the source index.", + "name": "source_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } }, { "aliases": [ - "gc", - "getCurrent" + "di", + "destIndex" ], - "description": "number of current get ops", - "name": "get.current", + "description": "The name of the destination index.", + "name": "dest_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } }, { - "description": "number of current get ops", - "name": "pri.get.current", + "aliases": [ + "d" + ], + "description": "A description of the job.", + "name": "description", "required": false, "type": { "kind": "instance_of", @@ -106833,11 +110272,11 @@ }, { "aliases": [ - "gti", - "getTime" + "mml", + "modelMemoryLimit" ], - "description": "time spent in get", - "name": "get.time", + "description": "The approximate maximum amount of memory resources that are permitted for the job.", + "name": "model_memory_limit", "required": false, "type": { "kind": "instance_of", @@ -106848,8 +110287,11 @@ } }, { - "description": "time spent in get", - "name": "pri.get.time", + "aliases": [ + "s" + ], + "description": "The current status of the job.", + "name": "state", "required": false, "type": { "kind": "instance_of", @@ -106861,11 +110303,11 @@ }, { "aliases": [ - "gto", - "getTotal" + "fr", + "failureReason" ], - "description": "number of get ops", - "name": "get.total", + "description": "Messages about the reason why the job failed.", + "name": "failure_reason", "required": false, "type": { "kind": "instance_of", @@ -106876,8 +110318,11 @@ } }, { - "description": "number of get ops", - "name": "pri.get.total", + "aliases": [ + "p" + ], + "description": "The progress report for the job by phase.", + "name": "progress", "required": false, "type": { "kind": "instance_of", @@ -106889,11 +110334,11 @@ }, { "aliases": [ - "geti", - "getExistsTime" + "ae", + "assignmentExplanation" ], - "description": "time spent in successful gets", - "name": "get.exists_time", + "description": "Messages related to the selection of a node.", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", @@ -106904,24 +110349,60 @@ } }, { - "description": "time spent in successful gets", - "name": "pri.get.exists_time", + "aliases": [ + "ni", + "nodeId" + ], + "description": "The unique identifier of the assigned node.", + "name": "node.id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "geto", - "getExistsTotal" + "nn", + "nodeName" ], - "description": "number of successful gets", - "name": "get.exists_total", + "description": "The name of the assigned node.", + "name": "node.name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "ne", + "nodeEphemeralId" + ], + "description": "The ephemeral identifier of the assigned node.", + "name": "node.ephemeral_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "aliases": [ + "na", + "nodeAddress" + ], + "description": "The network address of the assigned node.", + "name": "node.address", "required": false, "type": { "kind": "instance_of", @@ -106930,10 +110411,20 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_data_frame_analytics/types.ts#L22-L102" + }, + { + "kind": "interface", + "name": { + "name": "DatafeedsRecord", + "namespace": "cat.ml_datafeeds" + }, + "properties": [ { - "description": "number of successful gets", - "name": "pri.get.exists_total", + "description": "The datafeed identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", @@ -106945,23 +110436,25 @@ }, { "aliases": [ - "gmti", - "getMissingTime" + "s" ], - "description": "time spent in failed gets", - "name": "get.missing_time", + "description": "The status of the datafeed.", + "name": "state", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DatafeedState", + "namespace": "ml._types" } } }, { - "description": "time spent in failed gets", - "name": "pri.get.missing_time", + "aliases": [ + "ae" + ], + "description": "For started datafeeds only, contains messages relating to the selection of a node.", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", @@ -106973,11 +110466,11 @@ }, { "aliases": [ - "gmto", - "getMissingTotal" + "bc", + "bucketsCount" ], - "description": "number of failed gets", - "name": "get.missing_total", + "description": "The number of buckets processed.", + "name": "buckets.count", "required": false, "type": { "kind": "instance_of", @@ -106988,8 +110481,12 @@ } }, { - "description": "number of failed gets", - "name": "pri.get.missing_total", + "aliases": [ + "sc", + "searchCount" + ], + "description": "The number of searches run by the datafeed.", + "name": "search.count", "required": false, "type": { "kind": "instance_of", @@ -107001,11 +110498,11 @@ }, { "aliases": [ - "idc", - "indexingDeleteCurrent" + "st", + "searchTime" ], - "description": "number of current deletions", - "name": "indexing.delete_current", + "description": "The total time the datafeed spent searching, in milliseconds.", + "name": "search.time", "required": false, "type": { "kind": "instance_of", @@ -107016,8 +110513,12 @@ } }, { - "description": "number of current deletions", - "name": "pri.indexing.delete_current", + "aliases": [ + "sba", + "searchBucketAvg" + ], + "description": "The average search time per bucket, in milliseconds.", + "name": "search.bucket_avg", "required": false, "type": { "kind": "instance_of", @@ -107029,11 +110530,11 @@ }, { "aliases": [ - "idti", - "indexingDeleteTime" + "seah", + "searchExpAvgHour" ], - "description": "time spent in deletions", - "name": "indexing.delete_time", + "description": "The exponential average search time per hour, in milliseconds.", + "name": "search.exp_avg_hour", "required": false, "type": { "kind": "instance_of", @@ -107044,8 +110545,12 @@ } }, { - "description": "time spent in deletions", - "name": "pri.indexing.delete_time", + "aliases": [ + "ni", + "nodeId" + ], + "description": "The unique identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "name": "node.id", "required": false, "type": { "kind": "instance_of", @@ -107057,11 +110562,11 @@ }, { "aliases": [ - "idto", - "indexingDeleteTotal" + "nn", + "nodeName" ], - "description": "number of delete ops", - "name": "indexing.delete_total", + "description": "The name of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "name": "node.name", "required": false, "type": { "kind": "instance_of", @@ -107072,8 +110577,12 @@ } }, { - "description": "number of delete ops", - "name": "pri.indexing.delete_total", + "aliases": [ + "ne", + "nodeEphemeralId" + ], + "description": "The ephemeral identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "name": "node.ephemeral_id", "required": false, "type": { "kind": "instance_of", @@ -107085,11 +110594,11 @@ }, { "aliases": [ - "iic", - "indexingIndexCurrent" + "na", + "nodeAddress" ], - "description": "number of current indexing ops", - "name": "indexing.index_current", + "description": "The network address of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", + "name": "node.address", "required": false, "type": { "kind": "instance_of", @@ -107098,38 +110607,50 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_datafeeds/types.ts#L22-L87" + }, + { + "kind": "interface", + "name": { + "name": "JobsRecord", + "namespace": "cat.ml_jobs" + }, + "properties": [ { - "description": "number of current indexing ops", - "name": "pri.indexing.index_current", + "description": "The anomaly detection job identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "iiti", - "indexingIndexTime" + "s" ], - "description": "time spent in indexing", - "name": "indexing.index_time", + "description": "The status of the anomaly detection job.", + "name": "state", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "JobState", + "namespace": "ml._types" } } }, { - "description": "time spent in indexing", - "name": "pri.indexing.index_time", + "aliases": [ + "ot" + ], + "description": "For open jobs only, the amount of time the job has been opened.", + "name": "opened_time", "required": false, "type": { "kind": "instance_of", @@ -107141,11 +110662,10 @@ }, { "aliases": [ - "iito", - "indexingIndexTotal" + "ae" ], - "description": "number of indexing ops", - "name": "indexing.index_total", + "description": "For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.", + "name": "assignment_explanation", "required": false, "type": { "kind": "instance_of", @@ -107156,8 +110676,12 @@ } }, { - "description": "number of indexing ops", - "name": "pri.indexing.index_total", + "aliases": [ + "dpr", + "dataProcessedRecords" + ], + "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.", + "name": "data.processed_records", "required": false, "type": { "kind": "instance_of", @@ -107169,11 +110693,11 @@ }, { "aliases": [ - "iif", - "indexingIndexFailed" + "dpf", + "dataProcessedFields" ], - "description": "number of failed indexing ops", - "name": "indexing.index_failed", + "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.", + "name": "data.processed_fields", "required": false, "type": { "kind": "instance_of", @@ -107184,24 +110708,28 @@ } }, { - "description": "number of failed indexing ops", - "name": "pri.indexing.index_failed", + "aliases": [ + "dib", + "dataInputBytes" + ], + "description": "The number of bytes of input data posted to the anomaly detection job.", + "name": "data.input_bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "mc", - "mergesCurrent" + "dir", + "dataInputRecords" ], - "description": "number of current merges", - "name": "merges.current", + "description": "The number of input documents posted to the anomaly detection job.", + "name": "data.input_records", "required": false, "type": { "kind": "instance_of", @@ -107212,8 +110740,12 @@ } }, { - "description": "number of current merges", - "name": "pri.merges.current", + "aliases": [ + "dif", + "dataInputFields" + ], + "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.", + "name": "data.input_fields", "required": false, "type": { "kind": "instance_of", @@ -107225,11 +110757,11 @@ }, { "aliases": [ - "mcd", - "mergesCurrentDocs" + "did", + "dataInvalidDates" ], - "description": "number of current merging docs", - "name": "merges.current_docs", + "description": "The number of input documents with either a missing date field or a date that could not be parsed.", + "name": "data.invalid_dates", "required": false, "type": { "kind": "instance_of", @@ -107240,8 +110772,12 @@ } }, { - "description": "number of current merging docs", - "name": "pri.merges.current_docs", + "aliases": [ + "dmf", + "dataMissingFields" + ], + "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.", + "name": "data.missing_fields", "required": false, "type": { "kind": "instance_of", @@ -107253,11 +110789,11 @@ }, { "aliases": [ - "mcs", - "mergesCurrentSize" + "doot", + "dataOutOfOrderTimestamps" ], - "description": "size of current merges", - "name": "merges.current_size", + "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.", + "name": "data.out_of_order_timestamps", "required": false, "type": { "kind": "instance_of", @@ -107268,8 +110804,12 @@ } }, { - "description": "size of current merges", - "name": "pri.merges.current_size", + "aliases": [ + "deb", + "dataEmptyBuckets" + ], + "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`.", + "name": "data.empty_buckets", "required": false, "type": { "kind": "instance_of", @@ -107281,11 +110821,11 @@ }, { "aliases": [ - "mt", - "mergesTotal" + "dsb", + "dataSparseBuckets" ], - "description": "number of completed merge ops", - "name": "merges.total", + "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`.", + "name": "data.sparse_buckets", "required": false, "type": { "kind": "instance_of", @@ -107296,8 +110836,12 @@ } }, { - "description": "number of completed merge ops", - "name": "pri.merges.total", + "aliases": [ + "db", + "dataBuckets" + ], + "description": "The total number of buckets processed.", + "name": "data.buckets", "required": false, "type": { "kind": "instance_of", @@ -107309,11 +110853,11 @@ }, { "aliases": [ - "mtd", - "mergesTotalDocs" + "der", + "dataEarliestRecord" ], - "description": "docs merged", - "name": "merges.total_docs", + "description": "The timestamp of the earliest chronologically input document.", + "name": "data.earliest_record", "required": false, "type": { "kind": "instance_of", @@ -107324,8 +110868,12 @@ } }, { - "description": "docs merged", - "name": "pri.merges.total_docs", + "aliases": [ + "dlr", + "dataLatestRecord" + ], + "description": "The timestamp of the latest chronologically input document.", + "name": "data.latest_record", "required": false, "type": { "kind": "instance_of", @@ -107337,11 +110885,11 @@ }, { "aliases": [ - "mts", - "mergesTotalSize" + "dl", + "dataLast" ], - "description": "size merged", - "name": "merges.total_size", + "description": "The timestamp at which data was last analyzed, according to server time.", + "name": "data.last", "required": false, "type": { "kind": "instance_of", @@ -107352,8 +110900,12 @@ } }, { - "description": "size merged", - "name": "pri.merges.total_size", + "aliases": [ + "dleb", + "dataLastEmptyBucket" + ], + "description": "The timestamp of the last bucket that did not contain any data.", + "name": "data.last_empty_bucket", "required": false, "type": { "kind": "instance_of", @@ -107365,11 +110917,11 @@ }, { "aliases": [ - "mtt", - "mergesTotalTime" + "dlsb", + "dataLastSparseBucket" ], - "description": "time spent in merges", - "name": "merges.total_time", + "description": "The timestamp of the last bucket that was considered sparse.", + "name": "data.last_sparse_bucket", "required": false, "type": { "kind": "instance_of", @@ -107380,52 +110932,60 @@ } }, { - "description": "time spent in merges", - "name": "pri.merges.total_time", + "aliases": [ + "mb", + "modelBytes" + ], + "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.", + "name": "model.bytes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "rto", - "refreshTotal" + "mms", + "modelMemoryStatus" ], - "description": "total refreshes", - "name": "refresh.total", + "description": "The status of the mathematical models.", + "name": "model.memory_status", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "MemoryStatus", + "namespace": "ml._types" } } }, { - "description": "total refreshes", - "name": "pri.refresh.total", + "aliases": [ + "mbe", + "modelBytesExceeded" + ], + "description": "The number of bytes over the high limit for memory usage at the last allocation failure.", + "name": "model.bytes_exceeded", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "rti", - "refreshTime" + "mml", + "modelMemoryLimit" ], - "description": "time spent in refreshes", - "name": "refresh.time", + "description": "The upper limit for model memory usage, checked on increasing values.", + "name": "model.memory_limit", "required": false, "type": { "kind": "instance_of", @@ -107436,8 +110996,12 @@ } }, { - "description": "time spent in refreshes", - "name": "pri.refresh.time", + "aliases": [ + "mbf", + "modelByFields" + ], + "description": "The number of `by` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", + "name": "model.by_fields", "required": false, "type": { "kind": "instance_of", @@ -107449,10 +111013,11 @@ }, { "aliases": [ - "reto" + "mof", + "modelOverFields" ], - "description": "total external refreshes", - "name": "refresh.external_total", + "description": "The number of `over` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", + "name": "model.over_fields", "required": false, "type": { "kind": "instance_of", @@ -107463,8 +111028,12 @@ } }, { - "description": "total external refreshes", - "name": "pri.refresh.external_total", + "aliases": [ + "mpf", + "modelPartitionFields" + ], + "description": "The number of `partition` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", + "name": "model.partition_fields", "required": false, "type": { "kind": "instance_of", @@ -107476,10 +111045,11 @@ }, { "aliases": [ - "reti" + "mbaf", + "modelBucketAllocationFailures" ], - "description": "time spent in external refreshes", - "name": "refresh.external_time", + "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.", + "name": "model.bucket_allocation_failures", "required": false, "type": { "kind": "instance_of", @@ -107490,24 +111060,28 @@ } }, { - "description": "time spent in external refreshes", - "name": "pri.refresh.external_time", + "aliases": [ + "mcs", + "modelCategorizationStatus" + ], + "description": "The status of categorization for the job.", + "name": "model.categorization_status", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "CategorizationStatus", + "namespace": "ml._types" } } }, { "aliases": [ - "rli", - "refreshListeners" + "mcdc", + "modelCategorizedDocCount" ], - "description": "number of pending refresh listeners", - "name": "refresh.listeners", + "description": "The number of documents that have had a field categorized.", + "name": "model.categorized_doc_count", "required": false, "type": { "kind": "instance_of", @@ -107518,8 +111092,12 @@ } }, { - "description": "number of pending refresh listeners", - "name": "pri.refresh.listeners", + "aliases": [ + "mtcc", + "modelTotalCategoryCount" + ], + "description": "The number of categories created by categorization.", + "name": "model.total_category_count", "required": false, "type": { "kind": "instance_of", @@ -107531,11 +111109,10 @@ }, { "aliases": [ - "sfc", - "searchFetchCurrent" + "modelFrequentCategoryCount" ], - "description": "current fetch phase ops", - "name": "search.fetch_current", + "description": "The number of categories that match more than 1% of categorized documents.", + "name": "model.frequent_category_count", "required": false, "type": { "kind": "instance_of", @@ -107546,8 +111123,12 @@ } }, { - "description": "current fetch phase ops", - "name": "pri.search.fetch_current", + "aliases": [ + "mrcc", + "modelRareCategoryCount" + ], + "description": "The number of categories that match just one categorized document.", + "name": "model.rare_category_count", "required": false, "type": { "kind": "instance_of", @@ -107559,11 +111140,11 @@ }, { "aliases": [ - "sfti", - "searchFetchTime" + "mdcc", + "modelDeadCategoryCount" ], - "description": "time spent in fetch phase", - "name": "search.fetch_time", + "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.", + "name": "model.dead_category_count", "required": false, "type": { "kind": "instance_of", @@ -107574,8 +111155,12 @@ } }, { - "description": "time spent in fetch phase", - "name": "pri.search.fetch_time", + "aliases": [ + "mfcc", + "modelFailedCategoryCount" + ], + "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.", + "name": "model.failed_category_count", "required": false, "type": { "kind": "instance_of", @@ -107587,11 +111172,11 @@ }, { "aliases": [ - "sfto", - "searchFetchTotal" + "mlt", + "modelLogTime" ], - "description": "total fetch ops", - "name": "search.fetch_total", + "description": "The timestamp when the model stats were gathered, according to server time.", + "name": "model.log_time", "required": false, "type": { "kind": "instance_of", @@ -107602,8 +111187,12 @@ } }, { - "description": "total fetch ops", - "name": "pri.search.fetch_total", + "aliases": [ + "mt", + "modelTimestamp" + ], + "description": "The timestamp of the last record when the model stats were gathered.", + "name": "model.timestamp", "required": false, "type": { "kind": "instance_of", @@ -107615,11 +111204,11 @@ }, { "aliases": [ - "so", - "searchOpenContexts" + "ft", + "forecastsTotal" ], - "description": "open search contexts", - "name": "search.open_contexts", + "description": "The number of individual forecasts currently available for the job.\nA value of one or more indicates that forecasts exist.", + "name": "forecasts.total", "required": false, "type": { "kind": "instance_of", @@ -107630,8 +111219,12 @@ } }, { - "description": "open search contexts", - "name": "pri.search.open_contexts", + "aliases": [ + "fmmin", + "forecastsMemoryMin" + ], + "description": "The minimum memory usage in bytes for forecasts related to the anomaly detection job.", + "name": "forecasts.memory.min", "required": false, "type": { "kind": "instance_of", @@ -107643,11 +111236,11 @@ }, { "aliases": [ - "sqc", - "searchQueryCurrent" + "fmmax", + "forecastsMemoryMax" ], - "description": "current query phase ops", - "name": "search.query_current", + "description": "The maximum memory usage in bytes for forecasts related to the anomaly detection job.", + "name": "forecasts.memory.max", "required": false, "type": { "kind": "instance_of", @@ -107658,8 +111251,12 @@ } }, { - "description": "current query phase ops", - "name": "pri.search.query_current", + "aliases": [ + "fmavg", + "forecastsMemoryAvg" + ], + "description": "The average memory usage in bytes for forecasts related to the anomaly detection job.", + "name": "forecasts.memory.avg", "required": false, "type": { "kind": "instance_of", @@ -107671,11 +111268,11 @@ }, { "aliases": [ - "sqti", - "searchQueryTime" + "fmt", + "forecastsMemoryTotal" ], - "description": "time spent in query phase", - "name": "search.query_time", + "description": "The total memory usage in bytes for forecasts related to the anomaly detection job.", + "name": "forecasts.memory.total", "required": false, "type": { "kind": "instance_of", @@ -107686,8 +111283,12 @@ } }, { - "description": "time spent in query phase", - "name": "pri.search.query_time", + "aliases": [ + "frmin", + "forecastsRecordsMin" + ], + "description": "The minimum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "name": "forecasts.records.min", "required": false, "type": { "kind": "instance_of", @@ -107699,11 +111300,11 @@ }, { "aliases": [ - "sqto", - "searchQueryTotal" + "frmax", + "forecastsRecordsMax" ], - "description": "total query phase ops", - "name": "search.query_total", + "description": "The maximum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "name": "forecasts.records.max", "required": false, "type": { "kind": "instance_of", @@ -107714,8 +111315,12 @@ } }, { - "description": "total query phase ops", - "name": "pri.search.query_total", + "aliases": [ + "fravg", + "forecastsRecordsAvg" + ], + "description": "The average number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "name": "forecasts.records.avg", "required": false, "type": { "kind": "instance_of", @@ -107727,11 +111332,11 @@ }, { "aliases": [ - "scc", - "searchScrollCurrent" + "frt", + "forecastsRecordsTotal" ], - "description": "open scroll contexts", - "name": "search.scroll_current", + "description": "The total number of `model_forecast` documents written for forecasts related to the anomaly detection job.", + "name": "forecasts.records.total", "required": false, "type": { "kind": "instance_of", @@ -107742,8 +111347,12 @@ } }, { - "description": "open scroll contexts", - "name": "pri.search.scroll_current", + "aliases": [ + "ftmin", + "forecastsTimeMin" + ], + "description": "The minimum runtime in milliseconds for forecasts related to the anomaly detection job.", + "name": "forecasts.time.min", "required": false, "type": { "kind": "instance_of", @@ -107755,11 +111364,11 @@ }, { "aliases": [ - "scti", - "searchScrollTime" + "ftmax", + "forecastsTimeMax" ], - "description": "time scroll contexts held open", - "name": "search.scroll_time", + "description": "The maximum runtime in milliseconds for forecasts related to the anomaly detection job.", + "name": "forecasts.time.max", "required": false, "type": { "kind": "instance_of", @@ -107770,8 +111379,12 @@ } }, { - "description": "time scroll contexts held open", - "name": "pri.search.scroll_time", + "aliases": [ + "ftavg", + "forecastsTimeAvg" + ], + "description": "The average runtime in milliseconds for forecasts related to the anomaly detection job.", + "name": "forecasts.time.avg", "required": false, "type": { "kind": "instance_of", @@ -107783,11 +111396,11 @@ }, { "aliases": [ - "scto", - "searchScrollTotal" + "ftt", + "forecastsTimeTotal" ], - "description": "completed scroll contexts", - "name": "search.scroll_total", + "description": "The total runtime in milliseconds for forecasts related to the anomaly detection job.", + "name": "forecasts.time.total", "required": false, "type": { "kind": "instance_of", @@ -107798,24 +111411,28 @@ } }, { - "description": "completed scroll contexts", - "name": "pri.search.scroll_total", + "aliases": [ + "ni", + "nodeId" + ], + "description": "The uniqe identifier of the assigned node.", + "name": "node.id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "NodeId", + "namespace": "_types" } } }, { "aliases": [ - "sc", - "segmentsCount" + "nn", + "nodeName" ], - "description": "number of segments", - "name": "segments.count", + "description": "The name of the assigned node.", + "name": "node.name", "required": false, "type": { "kind": "instance_of", @@ -107826,24 +111443,28 @@ } }, { - "description": "number of segments", - "name": "pri.segments.count", + "aliases": [ + "ne", + "nodeEphemeralId" + ], + "description": "The ephemeral identifier of the assigned node.", + "name": "node.ephemeral_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "NodeId", + "namespace": "_types" } } }, { "aliases": [ - "sm", - "segmentsMemory" + "na", + "nodeAddress" ], - "description": "memory used by segments", - "name": "segments.memory", + "description": "The network address of the assigned node.", + "name": "node.address", "required": false, "type": { "kind": "instance_of", @@ -107854,8 +111475,12 @@ } }, { - "description": "memory used by segments", - "name": "pri.segments.memory", + "aliases": [ + "bc", + "bucketsCount" + ], + "description": "The number of bucket results produced by the job.", + "name": "buckets.count", "required": false, "type": { "kind": "instance_of", @@ -107867,11 +111492,11 @@ }, { "aliases": [ - "siwm", - "segmentsIndexWriterMemory" + "btt", + "bucketsTimeTotal" ], - "description": "memory used by index writer", - "name": "segments.index_writer_memory", + "description": "The sum of all bucket processing times, in milliseconds.", + "name": "buckets.time.total", "required": false, "type": { "kind": "instance_of", @@ -107882,8 +111507,12 @@ } }, { - "description": "memory used by index writer", - "name": "pri.segments.index_writer_memory", + "aliases": [ + "btmin", + "bucketsTimeMin" + ], + "description": "The minimum of all bucket processing times, in milliseconds.", + "name": "buckets.time.min", "required": false, "type": { "kind": "instance_of", @@ -107895,11 +111524,11 @@ }, { "aliases": [ - "svmm", - "segmentsVersionMapMemory" + "btmax", + "bucketsTimeMax" ], - "description": "memory used by version map", - "name": "segments.version_map_memory", + "description": "The maximum of all bucket processing times, in milliseconds.", + "name": "buckets.time.max", "required": false, "type": { "kind": "instance_of", @@ -107910,8 +111539,12 @@ } }, { - "description": "memory used by version map", - "name": "pri.segments.version_map_memory", + "aliases": [ + "btea", + "bucketsTimeExpAvg" + ], + "description": "The exponential moving average of all bucket processing times, in milliseconds.", + "name": "buckets.time.exp_avg", "required": false, "type": { "kind": "instance_of", @@ -107923,11 +111556,11 @@ }, { "aliases": [ - "sfbm", - "fixedBitsetMemory" + "bteah", + "bucketsTimeExpAvgHour" ], - "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", - "name": "segments.fixed_bitset_memory", + "description": "The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.", + "name": "buckets.time.exp_avg_hour", "required": false, "type": { "kind": "instance_of", @@ -107936,26 +111569,36 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_jobs/types.ts#L24-L347" + }, + { + "kind": "interface", + "name": { + "name": "TrainedModelsRecord", + "namespace": "cat.ml_trained_models" + }, + "properties": [ { - "description": "memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields", - "name": "pri.segments.fixed_bitset_memory", + "description": "The model identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { "aliases": [ - "wc", - "warmerCurrent" + "c", + "createdBy" ], - "description": "current warmer ops", - "name": "warmer.current", + "description": "Information about the creator of the model.", + "name": "created_by", "required": false, "type": { "kind": "instance_of", @@ -107966,24 +111609,28 @@ } }, { - "description": "current warmer ops", - "name": "pri.warmer.current", + "aliases": [ + "hs", + "modelHeapSize" + ], + "description": "The estimated heap size to keep the model in memory.", + "name": "heap_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { "aliases": [ - "wto", - "warmerTotal" + "o", + "modelOperations" ], - "description": "total warmer ops", - "name": "warmer.total", + "description": "The estimated number of operations to use the model.\nThis number helps to measure the computational complexity of the model.", + "name": "operations", "required": false, "type": { "kind": "instance_of", @@ -107994,8 +111641,11 @@ } }, { - "description": "total warmer ops", - "name": "pri.warmer.total", + "aliases": [ + "l" + ], + "description": "The license level of the model.", + "name": "license", "required": false, "type": { "kind": "instance_of", @@ -108007,39 +111657,40 @@ }, { "aliases": [ - "wtt", - "warmerTotalTime" + "ct" ], - "description": "time spent in warmers", - "name": "warmer.total_time", + "description": "The time the model was created.", + "name": "create_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "description": "time spent in warmers", - "name": "pri.warmer.total_time", + "aliases": [ + "v" + ], + "description": "The version of Elasticsearch when the model was created.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } }, { "aliases": [ - "suc", - "suggestCurrent" + "d" ], - "description": "number of current suggest ops", - "name": "suggest.current", + "description": "A description of the model.", + "name": "description", "required": false, "type": { "kind": "instance_of", @@ -108050,8 +111701,12 @@ } }, { - "description": "number of current suggest ops", - "name": "pri.suggest.current", + "aliases": [ + "ip", + "ingestPipelines" + ], + "description": "The number of pipelines that are referencing the model.", + "name": "ingest.pipelines", "required": false, "type": { "kind": "instance_of", @@ -108063,11 +111718,11 @@ }, { "aliases": [ - "suti", - "suggestTime" + "ic", + "ingestCount" ], - "description": "time spend in suggest", - "name": "suggest.time", + "description": "The total number of documents that are processed by the model.", + "name": "ingest.count", "required": false, "type": { "kind": "instance_of", @@ -108078,8 +111733,12 @@ } }, { - "description": "time spend in suggest", - "name": "pri.suggest.time", + "aliases": [ + "it", + "ingestTime" + ], + "description": "The total time spent processing documents with thie model.", + "name": "ingest.time", "required": false, "type": { "kind": "instance_of", @@ -108091,11 +111750,11 @@ }, { "aliases": [ - "suto", - "suggestTotal" + "icurr", + "ingestCurrent" ], - "description": "number of suggest ops", - "name": "suggest.total", + "description": "The total number of documents that are currently being handled by the model.", + "name": "ingest.current", "required": false, "type": { "kind": "instance_of", @@ -108106,8 +111765,12 @@ } }, { - "description": "number of suggest ops", - "name": "pri.suggest.total", + "aliases": [ + "if", + "ingestFailed" + ], + "description": "The total number of failed ingest attempts with the model.", + "name": "ingest.failed", "required": false, "type": { "kind": "instance_of", @@ -108119,11 +111782,11 @@ }, { "aliases": [ - "tm", - "memoryTotal" + "dfid", + "dataFrameAnalytics" ], - "description": "total used memory", - "name": "memory.total", + "description": "The identifier for the data frame analytics job that created the model.\nOnly displayed if the job is still available.", + "name": "data_frame.id", "required": false, "type": { "kind": "instance_of", @@ -108134,8 +111797,12 @@ } }, { - "description": "total user memory", - "name": "pri.memory.total", + "aliases": [ + "dft", + "dataFrameAnalyticsTime" + ], + "description": "The time the data frame analytics job was created.", + "name": "data_frame.create_time", "required": false, "type": { "kind": "instance_of", @@ -108147,10 +111814,11 @@ }, { "aliases": [ - "sth" + "dfsi", + "dataFrameAnalyticsSrcIndex" ], - "description": "indicates if the index is search throttled", - "name": "search.throttled", + "description": "The source index used to train in the data frame analysis.", + "name": "data_frame.source_index", "required": false, "type": { "kind": "instance_of", @@ -108162,11 +111830,11 @@ }, { "aliases": [ - "bto", - "bulkTotalOperation" + "dfa", + "dataFrameAnalyticsAnalysis" ], - "description": "number of bulk shard ops", - "name": "bulk.total_operations", + "description": "The analysis used by the data frame to build the model.", + "name": "data_frame.analysis", "required": false, "type": { "kind": "instance_of", @@ -108177,8 +111845,13 @@ } }, { - "description": "number of bulk shard ops", - "name": "pri.bulk.total_operations", + "availability": { + "serverless": {}, + "stack": { + "since": "8.0.0" + } + }, + "name": "type", "required": false, "type": { "kind": "instance_of", @@ -108187,26 +111860,35 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "cat/ml_trained_models/types.ts#L23-L115" + }, + { + "kind": "interface", + "name": { + "name": "TransformsRecord", + "namespace": "cat.transforms" + }, + "properties": [ { - "aliases": [ - "btti", - "bulkTotalTime" - ], - "description": "time spend in shard bulk", - "name": "bulk.total_time", + "description": "The transform identifier.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "description": "time spend in shard bulk", - "name": "pri.bulk.total_time", + "aliases": [ + "s" + ], + "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.", + "name": "state", "required": false, "type": { "kind": "instance_of", @@ -108218,11 +111900,10 @@ }, { "aliases": [ - "btsi", - "bulkTotalSizeInBytes" + "c" ], - "description": "total size in bytes of shard bulk", - "name": "bulk.total_size_in_bytes", + "description": "The sequence number for the checkpoint.", + "name": "checkpoint", "required": false, "type": { "kind": "instance_of", @@ -108233,8 +111914,12 @@ } }, { - "description": "total size in bytes of shard bulk", - "name": "pri.bulk.total_size_in_bytes", + "aliases": [ + "docp", + "documentsProcessed" + ], + "description": "The number of documents that have been processed from the source index of the transform.", + "name": "documents_processed", "required": false, "type": { "kind": "instance_of", @@ -108246,39 +111931,94 @@ }, { "aliases": [ - "bati", - "bulkAvgTime" + "cp", + "checkpointProgress" ], - "description": "average time spend in shard bulk", - "name": "bulk.avg_time", + "description": "The progress of the next checkpoint that is currently in progress.", + "name": "checkpoint_progress", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "description": "average time spend in shard bulk", - "name": "pri.bulk.avg_time", + "aliases": [ + "lst", + "lastSearchTime" + ], + "description": "The timestamp of the last search in the source indices.\nThis field is shown only if the transform is running.", + "name": "last_search_time", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { "aliases": [ - "basi", - "bulkAvgSizeInBytes" + "cldt" ], - "description": "average size in bytes of shard bulk", - "name": "bulk.avg_size_in_bytes", + "description": "The timestamp when changes were last detected in the source indices.", + "name": "changes_last_detection_time", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "aliases": [ + "ct", + "createTime" + ], + "description": "The time the transform was created.", + "name": "create_time", "required": false, "type": { "kind": "instance_of", @@ -108289,45 +112029,43 @@ } }, { - "description": "average size in bytes of shard bulk", - "name": "pri.bulk.avg_size_in_bytes", + "aliases": [ + "v" + ], + "description": "The version of Elasticsearch that existed on the node when the transform was created.", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } - } - ], - "specLocation": "cat/indices/types.ts#L20-L808" - }, - { - "kind": "interface", - "name": { - "name": "DataFrameAnalyticsRecord", - "namespace": "cat.ml_data_frame_analytics" - }, - "properties": [ + }, { - "description": "The identifier for the job.", - "name": "id", + "aliases": [ + "si", + "sourceIndex" + ], + "description": "The source indices for the transform.", + "name": "source_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "t" + "di", + "destIndex" ], - "description": "The type of analysis that the job performs.", - "name": "type", + "description": "The destination index for the transform.", + "name": "dest_index", "required": false, "type": { "kind": "instance_of", @@ -108339,11 +112077,10 @@ }, { "aliases": [ - "ct", - "createTime" + "p" ], - "description": "The time when the job was created.", - "name": "create_time", + "description": "The unique identifier for the ingest pipeline.", + "name": "pipeline", "required": false, "type": { "kind": "instance_of", @@ -108355,57 +112092,55 @@ }, { "aliases": [ - "v" + "d" ], - "description": "The version of Elasticsearch when the job was created.", - "name": "version", + "description": "The description of the transform.", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "si", - "sourceIndex" + "tt" ], - "description": "The name of the source index.", - "name": "source_index", + "description": "The type of transform: `batch` or `continuous`.", + "name": "transform_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "di", - "destIndex" + "f" ], - "description": "The name of the destination index.", - "name": "dest_index", + "description": "The interval between checks for changes in the source indices when the transform is running continuously.", + "name": "frequency", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "d" + "mpsz" ], - "description": "A description of the job.", - "name": "description", + "description": "The initial page size that is used for the composite aggregation for each checkpoint.", + "name": "max_page_search_size", "required": false, "type": { "kind": "instance_of", @@ -108417,11 +112152,10 @@ }, { "aliases": [ - "mml", - "modelMemoryLimit" + "dps" ], - "description": "The approximate maximum amount of memory resources that are permitted for the job.", - "name": "model_memory_limit", + "description": "The number of input documents per second.", + "name": "docs_per_second", "required": false, "type": { "kind": "instance_of", @@ -108433,10 +112167,10 @@ }, { "aliases": [ - "s" + "r" ], - "description": "The current status of the job.", - "name": "state", + "description": "If a transform has a `failed` state, these details describe the reason for failure.", + "name": "reason", "required": false, "type": { "kind": "instance_of", @@ -108448,11 +112182,10 @@ }, { "aliases": [ - "fr", - "failureReason" + "st" ], - "description": "Messages about the reason why the job failed.", - "name": "failure_reason", + "description": "The total number of search operations on the source index for the transform.", + "name": "search_total", "required": false, "type": { "kind": "instance_of", @@ -108464,10 +112197,10 @@ }, { "aliases": [ - "p" + "sf" ], - "description": "The progress report for the job by phase.", - "name": "progress", + "description": "The total number of search failures.", + "name": "search_failure", "required": false, "type": { "kind": "instance_of", @@ -108479,11 +112212,10 @@ }, { "aliases": [ - "ae", - "assignmentExplanation" + "stime" ], - "description": "Messages related to the selection of a node.", - "name": "assignment_explanation", + "description": "The total amount of search time, in milliseconds.", + "name": "search_time", "required": false, "type": { "kind": "instance_of", @@ -108495,59 +112227,55 @@ }, { "aliases": [ - "ni", - "nodeId" + "it" ], - "description": "The unique identifier of the assigned node.", - "name": "node.id", + "description": "The total number of index operations done by the transform.", + "name": "index_total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "nn", - "nodeName" + "if" ], - "description": "The name of the assigned node.", - "name": "node.name", + "description": "The total number of indexing failures.", + "name": "index_failure", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ne", - "nodeEphemeralId" + "itime" ], - "description": "The ephemeral identifier of the assigned node.", - "name": "node.ephemeral_id", + "description": "The total time spent indexing documents, in milliseconds.", + "name": "index_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "na", - "nodeAddress" + "doci" ], - "description": "The network address of the assigned node.", - "name": "node.address", + "description": "The number of documents that have been indexed into the destination index for the transform.", + "name": "documents_indexed", "required": false, "type": { "kind": "instance_of", @@ -108556,20 +112284,13 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "cat/ml_data_frame_analytics/types.ts#L22-L102" - }, - { - "kind": "interface", - "name": { - "name": "DatafeedsRecord", - "namespace": "cat.ml_datafeeds" - }, - "properties": [ + }, { - "description": "The datafeed identifier.", - "name": "id", + "aliases": [ + "dtime" + ], + "description": "The total time spent deleting documents, in milliseconds.", + "name": "delete_time", "required": false, "type": { "kind": "instance_of", @@ -108581,25 +112302,25 @@ }, { "aliases": [ - "s" + "docd" ], - "description": "The status of the datafeed.", - "name": "state", + "description": "The number of documents deleted from the destination index due to the retention policy for the transform.", + "name": "documents_deleted", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DatafeedState", - "namespace": "ml._types" + "name": "string", + "namespace": "_builtins" } } }, { "aliases": [ - "ae" + "tc" ], - "description": "For started datafeeds only, contains messages relating to the selection of a node.", - "name": "assignment_explanation", + "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.", + "name": "trigger_count", "required": false, "type": { "kind": "instance_of", @@ -108611,11 +112332,10 @@ }, { "aliases": [ - "bc", - "bucketsCount" + "pp" ], - "description": "The number of buckets processed.", - "name": "buckets.count", + "description": "The number of search or bulk index operations processed.\nDocuments are processed in batches instead of individually.", + "name": "pages_processed", "required": false, "type": { "kind": "instance_of", @@ -108627,11 +112347,10 @@ }, { "aliases": [ - "sc", - "searchCount" + "pt" ], - "description": "The number of searches run by the datafeed.", - "name": "search.count", + "description": "The total time spent processing results, in milliseconds.", + "name": "processing_time", "required": false, "type": { "kind": "instance_of", @@ -108643,11 +112362,11 @@ }, { "aliases": [ - "st", - "searchTime" + "cdtea", + "checkpointTimeExpAvg" ], - "description": "The total time the datafeed spent searching, in milliseconds.", - "name": "search.time", + "description": "The exponential moving average of the duration of the checkpoint, in milliseconds.", + "name": "checkpoint_duration_time_exp_avg", "required": false, "type": { "kind": "instance_of", @@ -108659,11 +112378,10 @@ }, { "aliases": [ - "sba", - "searchBucketAvg" + "idea" ], - "description": "The average search time per bucket, in milliseconds.", - "name": "search.bucket_avg", + "description": "The exponential moving average of the number of new documents that have been indexed.", + "name": "indexed_documents_exp_avg", "required": false, "type": { "kind": "instance_of", @@ -108675,11 +112393,10 @@ }, { "aliases": [ - "seah", - "searchExpAvgHour" + "pdea" ], - "description": "The exponential average search time per hour, in milliseconds.", - "name": "search.exp_avg_hour", + "description": "The exponential moving average of the number of documents that have been processed.", + "name": "processed_documents_exp_avg", "required": false, "type": { "kind": "instance_of", @@ -108688,193 +112405,256 @@ "namespace": "_builtins" } } + } + ], + "specLocation": "cat/transforms/types.ts#L22-L197" + }, + { + "kind": "interface", + "name": { + "name": "ComponentTemplate", + "namespace": "cluster._types" + }, + "properties": [ + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } }, { - "aliases": [ - "ni", - "nodeId" - ], - "description": "The unique identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", - "name": "node.id", - "required": false, + "name": "component_template", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ComponentTemplateNode", + "namespace": "cluster._types" + } + } + } + ], + "specLocation": "cluster/_types/ComponentTemplate.ts#L27-L30" + }, + { + "kind": "interface", + "name": { + "name": "ComponentTemplateNode", + "namespace": "cluster._types" + }, + "properties": [ + { + "name": "template", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ComponentTemplateSummary", + "namespace": "cluster._types" } } }, { - "aliases": [ - "nn", - "nodeName" - ], - "description": "The name of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", - "name": "node.name", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionNumber", + "namespace": "_types" } } }, { - "aliases": [ - "ne", - "nodeEphemeralId" - ], - "description": "The ephemeral identifier of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", - "name": "node.ephemeral_id", + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Metadata", + "namespace": "_types" } } }, { - "aliases": [ - "na", - "nodeAddress" - ], - "description": "The network address of the assigned node.\nFor started datafeeds only, this information pertains to the node upon which the datafeed is started.", - "name": "node.address", + "name": "deprecated", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } } ], - "specLocation": "cat/ml_datafeeds/types.ts#L22-L87" + "specLocation": "cluster/_types/ComponentTemplate.ts#L32-L41" }, { "kind": "interface", "name": { - "name": "JobsRecord", - "namespace": "cat.ml_jobs" + "name": "ComponentTemplateSummary", + "namespace": "cluster._types" }, "properties": [ { - "description": "The anomaly detection job identifier.", - "name": "id", + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Metadata", "namespace": "_types" } } }, { - "aliases": [ - "s" - ], - "description": "The status of the anomaly detection job.", - "name": "state", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "JobState", - "namespace": "ml._types" + "name": "VersionNumber", + "namespace": "_types" } } }, { - "aliases": [ - "ot" - ], - "description": "For open jobs only, the amount of time the job has been opened.", - "name": "opened_time", + "name": "settings", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "IndexSettings", + "namespace": "indices._types" + } } } }, { - "aliases": [ - "ae" - ], - "description": "For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.", - "name": "assignment_explanation", + "name": "mappings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "aliases": [ - "dpr", - "dataProcessedRecords" - ], - "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.", - "name": "data.processed_records", + "name": "aliases", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "AliasDefinition", + "namespace": "indices._types" + } } } }, { - "aliases": [ - "dpf", - "dataProcessedFields" - ], - "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.", - "name": "data.processed_fields", + "availability": { + "serverless": { + "stability": "stable" + }, + "stack": { + "since": "8.11.0", + "stability": "stable" + } + }, + "name": "lifecycle", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DataStreamLifecycleWithRollover", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "cluster/_types/ComponentTemplate.ts#L43-L55" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ { - "aliases": [ - "dib", - "dataInputBytes" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "user_defined_value" + } ], - "description": "The number of bytes of input data posted to the anomaly detection job.", - "name": "data.input_bytes", + "meta": { + "description": "Additional settings not covered in this type.", + "fieldname": "other_settings" + }, + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], + "docId": "index-modules-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings", + "kind": "interface", + "name": { + "name": "IndexSettings", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "IndexSettings", + "namespace": "indices._types" } } }, { - "aliases": [ - "dir", - "dataInputRecords" - ], - "description": "The number of input documents posted to the anomaly detection job.", - "name": "data.input_records", + "name": "mode", "required": false, "type": { "kind": "instance_of", @@ -108885,77 +112665,80 @@ } }, { - "aliases": [ - "dif", - "dataInputFields" - ], - "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.", - "name": "data.input_fields", + "name": "routing_path", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" + } + }, + { + "name": "soft_deletes", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SoftDeletes", + "namespace": "indices._types" } } }, { - "aliases": [ - "did", - "dataInvalidDates" - ], - "description": "The number of input documents with either a missing date field or a date that could not be parsed.", - "name": "data.invalid_dates", + "name": "sort", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexSegmentSort", + "namespace": "indices._types" } } }, { - "aliases": [ - "dmf", - "dataMissingFields" - ], - "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.", - "name": "data.missing_fields", + "name": "number_of_routing_shards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "doot", - "dataOutOfOrderTimestamps" - ], - "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.", - "name": "data.out_of_order_timestamps", + "name": "check_on_startup", "required": false, + "serverDefault": "false", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexCheckOnStartup", + "namespace": "indices._types" } } }, { - "aliases": [ - "deb", - "dataEmptyBuckets" - ], - "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`.", - "name": "data.empty_buckets", + "name": "codec", "required": false, + "serverDefault": "LZ4", "type": { "kind": "instance_of", "type": { @@ -108965,957 +112748,920 @@ } }, { - "aliases": [ - "dsb", - "dataSparseBuckets" - ], - "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`.", - "name": "data.sparse_buckets", + "name": "routing_partition_size", "required": false, + "serverDefault": "1", "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "aliases": [ - "db", - "dataBuckets" - ], - "description": "The total number of buckets processed.", - "name": "data.buckets", + "name": "load_fixed_bitset_filters_eagerly", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "aliases": [ - "der", - "dataEarliestRecord" - ], - "description": "The timestamp of the earliest chronologically input document.", - "name": "data.earliest_record", + "name": "hidden", + "required": false, + "serverDefault": "false", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "name": "auto_expand_replicas", "required": false, + "serverDefault": "false", "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "WithNullValue", + "namespace": "_spec_utils" } } }, { - "aliases": [ - "dlr", - "dataLatestRecord" - ], - "description": "The timestamp of the latest chronologically input document.", - "name": "data.latest_record", + "name": "merge", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Merge", + "namespace": "indices._types" } } }, { - "aliases": [ - "dl", - "dataLast" - ], - "description": "The timestamp at which data was last analyzed, according to server time.", - "name": "data.last", + "name": "search", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SettingsSearch", + "namespace": "indices._types" } } }, { - "aliases": [ - "dleb", - "dataLastEmptyBucket" - ], - "description": "The timestamp of the last bucket that did not contain any data.", - "name": "data.last_empty_bucket", + "name": "refresh_interval", "required": false, + "serverDefault": "1s", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "aliases": [ - "dlsb", - "dataLastSparseBucket" - ], - "description": "The timestamp of the last bucket that was considered sparse.", - "name": "data.last_sparse_bucket", + "name": "max_result_window", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "mb", - "modelBytes" - ], - "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.", - "name": "model.bytes", + "name": "max_inner_result_window", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "integer", "namespace": "_types" } } }, { - "aliases": [ - "mms", - "modelMemoryStatus" - ], - "description": "The status of the mathematical models.", - "name": "model.memory_status", + "name": "max_rescore_window", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "MemoryStatus", - "namespace": "ml._types" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "mbe", - "modelBytesExceeded" - ], - "description": "The number of bytes over the high limit for memory usage at the last allocation failure.", - "name": "model.bytes_exceeded", + "name": "max_docvalue_fields_search", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "integer", "namespace": "_types" } } }, { - "aliases": [ - "mml", - "modelMemoryLimit" - ], - "description": "The upper limit for model memory usage, checked on increasing values.", - "name": "model.memory_limit", + "name": "max_script_fields", "required": false, + "serverDefault": 32, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "mbf", - "modelByFields" - ], - "description": "The number of `by` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", - "name": "model.by_fields", + "name": "max_ngram_diff", "required": false, + "serverDefault": 1, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "mof", - "modelOverFields" - ], - "description": "The number of `over` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", - "name": "model.over_fields", + "name": "max_shingle_diff", "required": false, + "serverDefault": 3, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "mpf", - "modelPartitionFields" - ], - "description": "The number of `partition` field values that were analyzed by the models.\nThis value is cumulative for all detectors in the job.", - "name": "model.partition_fields", + "name": "blocks", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexSettingBlocks", + "namespace": "indices._types" } } }, { - "aliases": [ - "mbaf", - "modelBucketAllocationFailures" - ], - "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.", - "name": "model.bucket_allocation_failures", + "name": "max_refresh_listeners", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "mcs", - "modelCategorizationStatus" - ], - "description": "The status of categorization for the job.", - "name": "model.categorization_status", + "description": "Settings to define analyzers, tokenizers, token filters and character filters.", + "name": "analyze", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CategorizationStatus", - "namespace": "ml._types" + "name": "SettingsAnalyze", + "namespace": "indices._types" } } }, { - "aliases": [ - "mcdc", - "modelCategorizedDocCount" - ], - "description": "The number of documents that have had a field categorized.", - "name": "model.categorized_doc_count", + "name": "highlight", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SettingsHighlight", + "namespace": "indices._types" } } }, { - "aliases": [ - "mtcc", - "modelTotalCategoryCount" - ], - "description": "The number of categories created by categorization.", - "name": "model.total_category_count", + "name": "max_terms_count", "required": false, + "serverDefault": 65536, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "modelFrequentCategoryCount" - ], - "description": "The number of categories that match more than 1% of categorized documents.", - "name": "model.frequent_category_count", + "name": "max_regex_length", "required": false, + "serverDefault": 1000, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "mrcc", - "modelRareCategoryCount" - ], - "description": "The number of categories that match just one categorized document.", - "name": "model.rare_category_count", + "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexRouting", + "namespace": "indices._types" } } }, { - "aliases": [ - "mdcc", - "modelDeadCategoryCount" - ], - "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.", - "name": "model.dead_category_count", + "name": "gc_deletes", "required": false, + "serverDefault": "60s", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "aliases": [ - "mfcc", - "modelFailedCategoryCount" - ], - "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.", - "name": "model.failed_category_count", + "name": "default_pipeline", "required": false, + "serverDefault": "_none", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PipelineName", + "namespace": "_types" } } }, { - "aliases": [ - "mlt", - "modelLogTime" - ], - "description": "The timestamp when the model stats were gathered, according to server time.", - "name": "model.log_time", + "name": "final_pipeline", "required": false, + "serverDefault": "_none", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PipelineName", + "namespace": "_types" } } }, { - "aliases": [ - "mt", - "modelTimestamp" - ], - "description": "The timestamp of the last record when the model stats were gathered.", - "name": "model.timestamp", + "name": "lifecycle", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexSettingsLifecycle", + "namespace": "indices._types" } } }, { - "aliases": [ - "ft", - "forecastsTotal" - ], - "description": "The number of individual forecasts currently available for the job.\nA value of one or more indicates that forecasts exist.", - "name": "forecasts.total", + "name": "provided_name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "aliases": [ - "fmmin", - "forecastsMemoryMin" - ], - "description": "The minimum memory usage in bytes for forecasts related to the anomaly detection job.", - "name": "forecasts.memory.min", + "name": "creation_date", "required": false, "type": { + "generics": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "aliases": [ - "fmmax", - "forecastsMemoryMax" - ], - "description": "The maximum memory usage in bytes for forecasts related to the anomaly detection job.", - "name": "forecasts.memory.max", + "name": "creation_date_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "aliases": [ - "fmavg", - "forecastsMemoryAvg" - ], - "description": "The average memory usage in bytes for forecasts related to the anomaly detection job.", - "name": "forecasts.memory.avg", + "name": "uuid", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Uuid", + "namespace": "_types" } } }, { - "aliases": [ - "fmt", - "forecastsMemoryTotal" - ], - "description": "The total memory usage in bytes for forecasts related to the anomaly detection job.", - "name": "forecasts.memory.total", + "name": "version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexVersioning", + "namespace": "indices._types" } } }, { - "aliases": [ - "frmin", - "forecastsRecordsMin" - ], - "description": "The minimum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", - "name": "forecasts.records.min", + "name": "verified_before_close", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "aliases": [ - "frmax", - "forecastsRecordsMax" - ], - "description": "The maximum number of `model_forecast` documents written for forecasts related to the anomaly detection job.", - "name": "forecasts.records.max", + "name": "format", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], + "kind": "union_of" } }, { - "aliases": [ - "fravg", - "forecastsRecordsAvg" - ], - "description": "The average number of `model_forecast` documents written for forecasts related to the anomaly detection job.", - "name": "forecasts.records.avg", + "name": "max_slices_per_scroll", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "frt", - "forecastsRecordsTotal" - ], - "description": "The total number of `model_forecast` documents written for forecasts related to the anomaly detection job.", - "name": "forecasts.records.total", + "name": "translog", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Translog", + "namespace": "indices._types" } } }, { - "aliases": [ - "ftmin", - "forecastsTimeMin" - ], - "description": "The minimum runtime in milliseconds for forecasts related to the anomaly detection job.", - "name": "forecasts.time.min", + "name": "query_string", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SettingsQueryString", + "namespace": "indices._types" } } }, { - "aliases": [ - "ftmax", - "forecastsTimeMax" - ], - "description": "The maximum runtime in milliseconds for forecasts related to the anomaly detection job.", - "name": "forecasts.time.max", + "name": "priority", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "aliases": [ - "ftavg", - "forecastsTimeAvg" - ], - "description": "The average runtime in milliseconds for forecasts related to the anomaly detection job.", - "name": "forecasts.time.avg", + "name": "top_metrics_max_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "ftt", - "forecastsTimeTotal" - ], - "description": "The total runtime in milliseconds for forecasts related to the anomaly detection job.", - "name": "forecasts.time.total", + "name": "analysis", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexSettingsAnalysis", + "namespace": "indices._types" } } }, { - "aliases": [ - "ni", - "nodeId" - ], - "description": "The uniqe identifier of the assigned node.", - "name": "node.id", + "name": "settings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" + "name": "IndexSettings", + "namespace": "indices._types" } } }, { - "aliases": [ - "nn", - "nodeName" - ], - "description": "The name of the assigned node.", - "name": "node.name", + "name": "time_series", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexSettingsTimeSeries", + "namespace": "indices._types" } } }, { - "aliases": [ - "ne", - "nodeEphemeralId" - ], - "description": "The ephemeral identifier of the assigned node.", - "name": "node.ephemeral_id", + "name": "queries", "required": false, "type": { "kind": "instance_of", "type": { - "name": "NodeId", - "namespace": "_types" + "name": "Queries", + "namespace": "indices._types" } } }, { - "aliases": [ - "na", - "nodeAddress" - ], - "description": "The network address of the assigned node.", - "name": "node.address", + "description": "Configure custom similarity settings to customize how search results are scored.", + "name": "similarity", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "SettingsSimilarity", + "namespace": "indices._types" + } } } }, { - "aliases": [ - "bc", - "bucketsCount" - ], - "description": "The number of bucket results produced by the job.", - "name": "buckets.count", + "description": "Enable or disable dynamic mapping for an index.", + "name": "mapping", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "MappingLimitSettings", + "namespace": "indices._types" } } }, { - "aliases": [ - "btt", - "bucketsTimeTotal" - ], - "description": "The sum of all bucket processing times, in milliseconds.", - "name": "buckets.time.total", + "name": "indexing.slowlog", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexingSlowlogSettings", + "namespace": "indices._types" } } }, { - "aliases": [ - "btmin", - "bucketsTimeMin" - ], - "description": "The minimum of all bucket processing times, in milliseconds.", - "name": "buckets.time.min", + "description": "Configure indexing back pressure limits.", + "name": "indexing_pressure", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexingPressure", + "namespace": "indices._types" } } }, { - "aliases": [ - "btmax", - "bucketsTimeMax" - ], - "description": "The maximum of all bucket processing times, in milliseconds.", - "name": "buckets.time.max", + "description": "The store module allows you to control how index data is stored and accessed on disk.", + "name": "store", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Storage", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L70-L176" + }, + { + "kind": "interface", + "name": { + "name": "SoftDeletes", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "btea", - "bucketsTimeExpAvg" - ], - "description": "The exponential moving average of all bucket processing times, in milliseconds.", - "name": "buckets.time.exp_avg", + "description": "Indicates whether soft deletes are enabled on the index.", + "name": "enabled", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "aliases": [ - "bteah", - "bucketsTimeExpAvgHour" - ], - "description": "The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.", - "name": "buckets.time.exp_avg_hour", + "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.", + "name": "retention_lease", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "RetentionLease", + "namespace": "indices._types" } } } ], - "specLocation": "cat/ml_jobs/types.ts#L24-L347" + "specLocation": "indices/_types/IndexSettings.ts#L51-L64" }, { "kind": "interface", "name": { - "name": "TrainedModelsRecord", - "namespace": "cat.ml_trained_models" + "name": "RetentionLease", + "namespace": "indices._types" }, "properties": [ { - "description": "The model identifier.", - "name": "id", - "required": false, + "name": "period", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Duration", "namespace": "_types" } } - }, - { - "aliases": [ - "c", - "createdBy" - ], - "description": "Information about the creator of the model.", - "name": "created_by", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L66-L68" + }, + { + "kind": "interface", + "name": { + "name": "IndexSegmentSort", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "hs", - "modelHeapSize" - ], - "description": "The estimated heap size to keep the model in memory.", - "name": "heap_size", + "name": "field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "Fields", "namespace": "_types" } } }, { - "aliases": [ - "o", - "modelOperations" - ], - "description": "The estimated number of operations to use the model.\nThis number helps to measure the computational complexity of the model.", - "name": "operations", + "name": "order", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "SegmentSortOrder", + "namespace": "indices._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SegmentSortOrder", + "namespace": "indices._types" + } + } + } + ], + "kind": "union_of" } }, { - "aliases": [ - "l" - ], - "description": "The license level of the model.", - "name": "license", + "name": "mode", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "SegmentSortMode", + "namespace": "indices._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SegmentSortMode", + "namespace": "indices._types" + } + } + } + ], + "kind": "union_of" } }, { - "aliases": [ - "ct" - ], - "description": "The time the model was created.", - "name": "create_time", + "name": "missing", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "SegmentSortMissing", + "namespace": "indices._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SegmentSortMissing", + "namespace": "indices._types" + } + } + } + ], + "kind": "union_of" } - }, + } + ], + "specLocation": "indices/_types/IndexSegmentSort.ts#L22-L27" + }, + { + "kind": "interface", + "name": { + "name": "Merge", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "v" - ], - "description": "The version of Elasticsearch when the model was created.", - "name": "version", + "name": "scheduler", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "MergeScheduler", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L346-L348" + }, + { + "kind": "interface", + "name": { + "name": "MergeScheduler", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "d" - ], - "description": "A description of the model.", - "name": "description", + "name": "max_thread_count", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "aliases": [ - "ip", - "ingestPipelines" - ], - "description": "The number of pipelines that are referencing the model.", - "name": "ingest.pipelines", + "name": "max_merge_count", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L350-L353" + }, + { + "kind": "interface", + "name": { + "name": "SettingsSearch", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "ic", - "ingestCount" - ], - "description": "The total number of documents that are processed by the model.", - "name": "ingest.count", + "name": "idle", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SearchIdle", + "namespace": "indices._types" } } }, { - "aliases": [ - "it", - "ingestTime" - ], - "description": "The total time spent processing documents with thie model.", - "name": "ingest.time", + "name": "slowlog", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SlowlogSettings", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L248-L251" + }, + { + "kind": "interface", + "name": { + "name": "SearchIdle", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "icurr", - "ingestCurrent" - ], - "description": "The total number of documents that are currently being handled by the model.", - "name": "ingest.current", + "name": "after", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L253-L256" + }, + { + "kind": "interface", + "name": { + "name": "SlowlogSettings", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "if", - "ingestFailed" - ], - "description": "The total number of failed ingest attempts with the model.", - "name": "ingest.failed", + "name": "level", "required": false, "type": { "kind": "instance_of", @@ -109926,426 +113672,385 @@ } }, { - "aliases": [ - "dfid", - "dataFrameAnalytics" - ], - "description": "The identifier for the data frame analytics job that created the model.\nOnly displayed if the job is still available.", - "name": "data_frame.id", + "name": "source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "aliases": [ - "dft", - "dataFrameAnalyticsTime" - ], - "description": "The time the data frame analytics job was created.", - "name": "data_frame.create_time", + "name": "reformat", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "aliases": [ - "dfsi", - "dataFrameAnalyticsSrcIndex" - ], - "description": "The source index used to train in the data frame analysis.", - "name": "data_frame.source_index", + "name": "threshold", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SlowlogTresholds", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L515-L520" + }, + { + "kind": "interface", + "name": { + "name": "SlowlogTresholds", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "dfa", - "dataFrameAnalyticsAnalysis" - ], - "description": "The analysis used by the data frame to build the model.", - "name": "data_frame.analysis", + "name": "query", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SlowlogTresholdLevels", + "namespace": "indices._types" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "8.0.0" - } - }, - "name": "type", + "name": "fetch", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SlowlogTresholdLevels", + "namespace": "indices._types" } } } ], - "specLocation": "cat/ml_trained_models/types.ts#L23-L115" + "specLocation": "indices/_types/IndexSettings.ts#L522-L525" }, { "kind": "interface", "name": { - "name": "TransformsRecord", - "namespace": "cat.transforms" + "name": "SlowlogTresholdLevels", + "namespace": "indices._types" }, "properties": [ { - "description": "The transform identifier.", - "name": "id", + "name": "warn", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "Duration", "namespace": "_types" } } }, { - "aliases": [ - "s" - ], - "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.", - "name": "state", + "name": "info", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "aliases": [ - "c" - ], - "description": "The sequence number for the checkpoint.", - "name": "checkpoint", + "name": "debug", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "aliases": [ - "docp", - "documentsProcessed" - ], - "description": "The number of documents that have been processed from the source index of the transform.", - "name": "documents_processed", + "name": "trace", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } - }, - { - "aliases": [ - "cp", - "checkpointProgress" - ], - "description": "The progress of the next checkpoint that is currently in progress.", - "name": "checkpoint_progress", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L527-L532" + }, + { + "kind": "interface", + "name": { + "name": "IndexSettingBlocks", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "lst", - "lastSearchTime" - ], - "description": "The timestamp of the last search in the source indices.\nThis field is shown only if the transform is running.", - "name": "last_search_time", + "name": "read_only", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, + "generics": [ { "kind": "instance_of", "type": { - "name": "null", + "name": "boolean", "namespace": "_builtins" } } ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "Stringified", + "namespace": "_spec_utils" + } } }, { - "aliases": [ - "cldt" - ], - "description": "The timestamp when changes were last detected in the source indices.", - "name": "changes_last_detection_time", + "name": "read_only_allow_delete", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, + "generics": [ { "kind": "instance_of", "type": { - "name": "null", + "name": "boolean", "namespace": "_builtins" } } ], - "kind": "union_of" - } - }, - { - "aliases": [ - "ct", - "createTime" - ], - "description": "The time the transform was created.", - "name": "create_time", - "required": false, - "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "aliases": [ - "v" - ], - "description": "The version of Elasticsearch that existed on the node when the transform was created.", - "name": "version", + "name": "read", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "VersionString", - "namespace": "_types" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "aliases": [ - "si", - "sourceIndex" - ], - "description": "The source indices for the transform.", - "name": "source_index", + "name": "write", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "aliases": [ - "di", - "destIndex" - ], - "description": "The destination index for the transform.", - "name": "dest_index", + "name": "metadata", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L262-L268" + }, + { + "kind": "interface", + "name": { + "name": "SettingsAnalyze", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "p" - ], - "description": "The unique identifier for the ingest pipeline.", - "name": "pipeline", + "name": "max_token_count", "required": false, + "serverDefault": "10000", "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L243-L246" + }, + { + "kind": "interface", + "name": { + "name": "SettingsHighlight", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "d" - ], - "description": "The description of the transform.", - "name": "description", + "name": "max_analyzed_offset", "required": false, + "serverDefault": 1000000, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L238-L241" + }, + { + "kind": "interface", + "name": { + "name": "IndexRouting", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "tt" - ], - "description": "The type of transform: `batch` or `continuous`.", - "name": "transform_type", + "name": "allocation", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexRoutingAllocation", + "namespace": "indices._types" } } }, { - "aliases": [ - "f" - ], - "description": "The interval between checks for changes in the source indices when the transform is running continuously.", - "name": "frequency", + "name": "rebalance", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexRoutingRebalance", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L22-L25" + }, + { + "kind": "interface", + "name": { + "name": "IndexRoutingAllocation", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "mpsz" - ], - "description": "The initial page size that is used for the composite aggregation for each checkpoint.", - "name": "max_page_search_size", + "name": "enable", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexRoutingAllocationOptions", + "namespace": "indices._types" } } }, { - "aliases": [ - "dps" - ], - "description": "The number of input documents per second.", - "name": "docs_per_second", + "name": "include", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexRoutingAllocationInclude", + "namespace": "indices._types" } } }, { - "aliases": [ - "r" - ], - "description": "If a transform has a `failed` state, these details describe the reason for failure.", - "name": "reason", + "name": "initial_recovery", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexRoutingAllocationInitialRecovery", + "namespace": "indices._types" } } }, { - "aliases": [ - "st" - ], - "description": "The total number of search operations on the source index for the transform.", - "name": "search_total", + "name": "disk", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexRoutingAllocationDisk", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L27-L32" + }, + { + "kind": "interface", + "name": { + "name": "IndexRoutingAllocationInclude", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "sf" - ], - "description": "The total number of search failures.", - "name": "search_failure", + "name": "_tier_preference", "required": false, "type": { "kind": "instance_of", @@ -110356,132 +114061,176 @@ } }, { - "aliases": [ - "stime" - ], - "description": "The total amount of search time, in milliseconds.", - "name": "search_time", + "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L52-L55" + }, + { + "kind": "interface", + "name": { + "name": "IndexRoutingAllocationInitialRecovery", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "it" - ], - "description": "The total number of index operations done by the transform.", - "name": "index_total", + "name": "_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L57-L59" + }, + { + "kind": "interface", + "name": { + "name": "IndexRoutingAllocationDisk", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "if" - ], - "description": "The total number of indexing failures.", - "name": "index_failure", + "name": "threshold_enabled", "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L62-L64" + }, + { + "kind": "interface", + "name": { + "name": "IndexRoutingRebalance", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "enable", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexRoutingRebalanceOptions", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexRouting.ts#L34-L36" + }, + { + "kind": "interface", + "name": { + "name": "IndexSettingsLifecycle", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "itime" - ], - "description": "The total time spent indexing documents, in milliseconds.", - "name": "index_time", + "description": "The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates.", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "aliases": [ - "doci" - ], - "description": "The number of documents that have been indexed into the destination index for the transform.", - "name": "documents_indexed", + "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.", + "name": "indexing_complete", "required": false, + "serverDefault": "false", "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } }, { - "aliases": [ - "dtime" - ], - "description": "The total time spent deleting documents, in milliseconds.", - "name": "delete_time", + "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.", + "name": "origination_date", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "aliases": [ - "docd" - ], - "description": "The number of documents deleted from the destination index due to the retention policy for the transform.", - "name": "documents_deleted", + "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.", + "name": "parse_origination_date", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "aliases": [ - "tc" - ], - "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.", - "name": "trigger_count", + "name": "step", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexSettingsLifecycleStep", + "namespace": "indices._types" } } }, { - "aliases": [ - "pp" - ], - "description": "The number of search or bulk index operations processed.\nDocuments are processed in batches instead of individually.", - "name": "pages_processed", + "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.", + "name": "rollover_alias", "required": false, + "serverDefault": "", "type": { "kind": "instance_of", "type": { @@ -110491,57 +114240,75 @@ } }, { - "aliases": [ - "pt" - ], - "description": "The total time spent processing results, in milliseconds.", - "name": "processing_time", + "description": "Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are\napplicable for an index).", + "name": "prefer_ilm", "required": false, + "serverDefault": "true", "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L284-L323" + }, + { + "kind": "interface", + "name": { + "name": "IndexSettingsLifecycleStep", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "cdtea", - "checkpointTimeExpAvg" - ], - "description": "The exponential moving average of the duration of the checkpoint, in milliseconds.", - "name": "checkpoint_duration_time_exp_avg", + "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.", + "name": "wait_time_threshold", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L325-L331" + }, + { + "kind": "interface", + "name": { + "name": "IndexVersioning", + "namespace": "indices._types" + }, + "properties": [ { - "aliases": [ - "idea" - ], - "description": "The exponential moving average of the number of new documents that have been indexed.", - "name": "indexed_documents_exp_avg", + "name": "created", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "VersionString", + "namespace": "_types" } } }, { - "aliases": [ - "pdea" - ], - "description": "The exponential moving average of the number of documents that have been processed.", - "name": "processed_documents_exp_avg", + "name": "created_string", "required": false, "type": { "kind": "instance_of", @@ -110552,136 +114319,194 @@ } } ], - "specLocation": "cat/transforms/types.ts#L22-L197" + "specLocation": "indices/_types/IndexSettings.ts#L279-L282" }, { "kind": "interface", "name": { - "name": "ComponentTemplate", - "namespace": "cluster._types" + "name": "Translog", + "namespace": "indices._types" }, "properties": [ { - "name": "name", - "required": true, + "description": "How often the translog is fsynced to disk and committed, regardless of write operations.\nValues less than 100ms are not allowed.", + "name": "sync_interval", + "required": false, + "serverDefault": "5s", "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request.", + "name": "durability", + "required": false, + "serverDefault": "string", + "type": { + "kind": "instance_of", + "type": { + "name": "TranslogDurability", + "namespace": "indices._types" + } + } + }, + { + "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.", + "name": "flush_threshold_size", + "required": false, + "serverDefault": "512mb", + "type": { + "kind": "instance_of", + "type": { + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "component_template", - "required": true, + "name": "retention", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ComponentTemplateNode", - "namespace": "cluster._types" + "name": "TranslogRetention", + "namespace": "indices._types" } } } ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L27-L30" + "specLocation": "indices/_types/IndexSettings.ts#L355-L377" }, { "kind": "interface", "name": { - "name": "ComponentTemplateNode", - "namespace": "cluster._types" + "name": "TranslogRetention", + "namespace": "indices._types" }, "properties": [ { - "name": "template", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ComponentTemplateSummary", - "namespace": "cluster._types" - } - } - }, - { - "name": "version", + "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.", + "name": "size", "required": false, + "serverDefault": "512mb", "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", + "name": "ByteSize", "namespace": "_types" } } }, { - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "_meta", + "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.", + "name": "age", "required": false, + "serverDefault": "12h", "type": { "kind": "instance_of", "type": { - "name": "Metadata", + "name": "Duration", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L396-L415" + }, + { + "kind": "interface", + "name": { + "name": "SettingsQueryString", + "namespace": "indices._types" + }, + "properties": [ { - "name": "deprecated", - "required": false, + "name": "lenient", + "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + ], "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Stringified", + "namespace": "_spec_utils" } } } ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L32-L41" + "specLocation": "indices/_types/IndexSettings.ts#L258-L260" }, { "kind": "interface", "name": { - "name": "ComponentTemplateSummary", - "namespace": "cluster._types" + "name": "IndexSettingsAnalysis", + "namespace": "indices._types" }, "properties": [ { - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "_meta", + "name": "analyzer", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Analyzer", + "namespace": "_types.analysis" + } } } }, { - "name": "version", + "name": "char_filter", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "CharFilter", + "namespace": "_types.analysis" + } } } }, { - "name": "settings", + "name": "filter", "required": false, "type": { "key": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } }, "kind": "dictionary_of", @@ -110689,25 +114514,36 @@ "value": { "kind": "instance_of", "type": { - "name": "IndexSettings", - "namespace": "indices._types" + "name": "TokenFilter", + "namespace": "_types.analysis" } } } }, { - "name": "mappings", + "name": "normalizer", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Normalizer", + "namespace": "_types.analysis" + } } } }, { - "name": "aliases", + "name": "tokenizer", "required": false, "type": { "key": { @@ -110722,213 +114558,190 @@ "value": { "kind": "instance_of", "type": { - "name": "AliasDefinition", - "namespace": "indices._types" + "name": "Tokenizer", + "namespace": "_types.analysis" } } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L333-L339" + }, + { + "kind": "interface", + "name": { + "name": "IndexSettingsTimeSeries", + "namespace": "indices._types" + }, + "properties": [ { - "availability": { - "serverless": { - "stability": "stable" - }, - "stack": { - "since": "8.11.0", - "stability": "stable" - } - }, - "name": "lifecycle", + "name": "end_time", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamLifecycleWithRollover", - "namespace": "indices._types" + "name": "DateTime", + "namespace": "_types" } } - } - ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L43-L55" - }, - { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ + }, { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "user_defined_value" - } - ], - "meta": { - "description": "Additional settings not covered in this type.", - "fieldname": "other_settings" - }, + "name": "start_time", + "required": false, "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } } } ], - "docId": "index-modules-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings", + "specLocation": "indices/_types/IndexSettings.ts#L341-L344" + }, + { "kind": "interface", "name": { - "name": "IndexSettings", + "name": "Queries", "namespace": "indices._types" }, "properties": [ { - "name": "index", + "name": "cache", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettings", + "name": "CacheQueries", "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L417-L419" + }, + { + "kind": "interface", + "name": { + "name": "CacheQueries", + "namespace": "indices._types" + }, + "properties": [ { - "name": "mode", - "required": false, + "name": "enabled", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L421-L423" + }, + { + "description": "Mapping Limit Settings", + "docId": "mapping-settings-limit", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-settings-limit.html", + "kind": "interface", + "name": { + "name": "MappingLimitSettings", + "namespace": "indices._types" + }, + "properties": [ { - "name": "routing_path", + "name": "coerce", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } }, { - "name": "soft_deletes", + "name": "total_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SoftDeletes", + "name": "MappingLimitSettingsTotalFields", "namespace": "indices._types" } } }, { - "name": "sort", + "name": "depth", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSegmentSort", + "name": "MappingLimitSettingsDepth", "namespace": "indices._types" } } }, { - "name": "number_of_routing_shards", + "name": "nested_fields", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "MappingLimitSettingsNestedFields", + "namespace": "indices._types" } } }, { - "name": "check_on_startup", + "name": "nested_objects", "required": false, - "serverDefault": "false", "type": { "kind": "instance_of", "type": { - "name": "IndexCheckOnStartup", + "name": "MappingLimitSettingsNestedObjects", "namespace": "indices._types" } } }, { - "name": "codec", + "name": "field_name_length", "required": false, - "serverDefault": "LZ4", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "MappingLimitSettingsFieldNameLength", + "namespace": "indices._types" } } }, { - "name": "routing_partition_size", + "name": "dimension_fields", "required": false, - "serverDefault": "1", "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "MappingLimitSettingsDimensionFields", + "namespace": "indices._types" } } }, { - "name": "load_fixed_bitset_filters_eagerly", + "name": "source", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "MappingLimitSettingsSourceFields", + "namespace": "indices._types" } } }, { - "name": "hidden", + "name": "ignore_malformed", "required": false, - "serverDefault": "false", "type": { "items": [ { @@ -110948,13 +114761,31 @@ ], "kind": "union_of" } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L425-L439" + }, + { + "kind": "interface", + "name": { + "name": "MappingLimitSettingsTotalFields", + "namespace": "indices._types" + }, + "properties": [ { - "name": "auto_expand_replicas", + "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.", + "name": "limit", "required": false, - "serverDefault": "false", + "serverDefault": "1000", "type": { - "generics": [ + "items": [ + { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + }, { "kind": "instance_of", "type": { @@ -110963,192 +114794,281 @@ } } ], - "kind": "instance_of", - "type": { - "name": "WithNullValue", - "namespace": "_spec_utils" - } - } - }, - { - "name": "merge", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Merge", - "namespace": "indices._types" - } - } - }, - { - "name": "search", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SettingsSearch", - "namespace": "indices._types" - } + "kind": "union_of" } }, { - "name": "refresh_interval", + "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.", + "name": "ignore_dynamic_beyond_limit", "required": false, - "serverDefault": "1s", + "serverDefault": "false", "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L441-L458" + }, + { + "kind": "interface", + "name": { + "name": "MappingLimitSettingsDepth", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_result_window", + "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.", + "name": "limit", "required": false, - "serverDefault": 10000, + "serverDefault": 20, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L460-L467" + }, + { + "kind": "interface", + "name": { + "name": "MappingLimitSettingsNestedFields", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_inner_result_window", + "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.", + "name": "limit", "required": false, - "serverDefault": 100, + "serverDefault": 50, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L469-L477" + }, + { + "kind": "interface", + "name": { + "name": "MappingLimitSettingsNestedObjects", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_rescore_window", + "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.", + "name": "limit", "required": false, "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L479-L486" + }, + { + "kind": "interface", + "name": { + "name": "MappingLimitSettingsFieldNameLength", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_docvalue_fields_search", + "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).", + "name": "limit", "required": false, - "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L488-L495" + }, + { + "kind": "interface", + "name": { + "name": "MappingLimitSettingsDimensionFields", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_script_fields", + "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.", + "name": "limit", "required": false, - "serverDefault": 32, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L497-L503" + }, + { + "kind": "interface", + "name": { + "name": "MappingLimitSettingsSourceFields", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_ngram_diff", - "required": false, - "serverDefault": 1, + "name": "mode", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "SourceMode", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L505-L507" + }, + { + "kind": "interface", + "name": { + "name": "IndexingSlowlogSettings", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_shingle_diff", + "name": "level", "required": false, - "serverDefault": 3, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "blocks", + "name": "source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettingBlocks", - "namespace": "indices._types" + "name": "integer", + "namespace": "_types" } } }, { - "name": "max_refresh_listeners", + "name": "reformat", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Settings to define analyzers, tokenizers, token filters and character filters.", - "name": "analyze", + "name": "threshold", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SettingsAnalyze", + "name": "IndexingSlowlogTresholds", "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L588-L593" + }, + { + "kind": "interface", + "name": { + "name": "IndexingSlowlogTresholds", + "namespace": "indices._types" + }, + "properties": [ { - "name": "highlight", + "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.", + "docId": "index-modules-slowlog-slowlog", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-slowlog.html#index-slow-log", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SettingsHighlight", + "name": "SlowlogTresholdLevels", "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L595-L602" + }, + { + "kind": "interface", + "name": { + "name": "IndexingPressure", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_terms_count", - "required": false, - "serverDefault": 65536, + "name": "memory", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "IndexingPressureMemory", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L575-L577" + }, + { + "kind": "interface", + "name": { + "name": "IndexingPressureMemory", + "namespace": "indices._types" + }, + "properties": [ { - "name": "max_regex_length", + "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.", + "name": "limit", "required": false, - "serverDefault": 1000, "type": { "kind": "instance_of", "type": { @@ -111156,380 +115076,374 @@ "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L579-L586" + }, + { + "kind": "interface", + "name": { + "name": "Storage", + "namespace": "indices._types" + }, + "properties": [ { - "name": "routing", - "required": false, + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexRouting", + "name": "StorageType", "namespace": "indices._types" } } }, { - "name": "gc_deletes", + "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.", + "name": "allow_mmap", "required": false, - "serverDefault": "60s", "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "indices/_types/IndexSettings.ts#L534-L543" + }, + { + "kind": "interface", + "name": { + "name": "TypeMapping", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "default_pipeline", + "name": "all_field", "required": false, - "serverDefault": "_none", "type": { "kind": "instance_of", "type": { - "name": "PipelineName", - "namespace": "_types" + "name": "AllField", + "namespace": "_types.mapping" } } }, { - "name": "final_pipeline", + "name": "date_detection", "required": false, - "serverDefault": "_none", "type": { "kind": "instance_of", "type": { - "name": "PipelineName", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "lifecycle", + "name": "dynamic", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettingsLifecycle", - "namespace": "indices._types" + "name": "DynamicMapping", + "namespace": "_types.mapping" } } }, { - "name": "provided_name", + "name": "dynamic_date_formats", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "creation_date", + "name": "dynamic_templates", "required": false, "type": { - "generics": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], + "kind": "array_of", + "value": { + "key": { "kind": "instance_of", "type": { - "name": "EpochTime", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "DynamicTemplate", + "namespace": "_types.mapping" } } - ], - "kind": "instance_of", - "type": { - "name": "Stringified", - "namespace": "_spec_utils" } } }, { - "name": "creation_date_string", + "name": "_field_names", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "FieldNamesField", + "namespace": "_types.mapping" } } }, { - "name": "uuid", + "name": "index_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Uuid", - "namespace": "_types" + "name": "IndexField", + "namespace": "_types.mapping" } } }, { - "name": "version", + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexVersioning", - "namespace": "indices._types" + "name": "Metadata", + "namespace": "_types" } } }, { - "name": "verified_before_close", + "name": "numeric_detection", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } } }, { - "name": "format", + "name": "properties", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } + "key": { + "kind": "instance_of", + "type": { + "name": "PropertyName", + "namespace": "_types" } - ], - "kind": "union_of" + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Property", + "namespace": "_types.mapping" + } + } } }, { - "name": "max_slices_per_scroll", + "name": "_routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "RoutingField", + "namespace": "_types.mapping" } } }, { - "name": "translog", + "name": "_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Translog", - "namespace": "indices._types" + "name": "SizeField", + "namespace": "_types.mapping" } } }, { - "name": "query_string", + "name": "_source", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SettingsQueryString", - "namespace": "indices._types" + "name": "SourceField", + "namespace": "_types.mapping" } } }, { - "name": "priority", + "name": "runtime", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ], - "kind": "union_of" + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "RuntimeField", + "namespace": "_types.mapping" + } + } } }, { - "name": "top_metrics_max_size", + "name": "enabled", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "analysis", + "name": "subobjects", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettingsAnalysis", - "namespace": "indices._types" + "name": "Subobjects", + "namespace": "_types.mapping" } } }, { - "name": "settings", + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "name": "_data_stream_timestamp", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettings", - "namespace": "indices._types" + "name": "DataStreamTimestamp", + "namespace": "_types.mapping" } } - }, + } + ], + "specLocation": "_types/mapping/TypeMapping.ts#L34-L57" + }, + { + "kind": "interface", + "name": { + "name": "AllField", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "time_series", - "required": false, + "name": "analyzer", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexSettingsTimeSeries", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "queries", - "required": false, + "name": "enabled", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Queries", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Configure custom similarity settings to customize how search results are scored.", - "name": "similarity", - "required": false, + "name": "omit_norms", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "SettingsSimilarity", - "namespace": "indices._types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Enable or disable dynamic mapping for an index.", - "name": "mapping", - "required": false, + "name": "search_analyzer", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettings", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "indexing.slowlog", - "required": false, + "name": "similarity", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexingSlowlogSettings", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Configure indexing back pressure limits.", - "name": "indexing_pressure", - "required": false, + "name": "store", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexingPressure", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The store module allows you to control how index data is stored and accessed on disk.", - "name": "store", - "required": false, + "name": "store_term_vector_offsets", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Storage", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L70-L176" - }, - { - "kind": "interface", - "name": { - "name": "SoftDeletes", - "namespace": "indices._types" - }, - "properties": [ + }, { - "description": "Indicates whether soft deletes are enabled on the index.", - "name": "enabled", - "required": false, - "serverDefault": true, + "name": "store_term_vector_payloads", + "required": true, "type": { "kind": "instance_of", "type": { @@ -111539,69 +115453,70 @@ } }, { - "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.", - "name": "retention_lease", - "required": false, + "name": "store_term_vector_positions", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "RetentionLease", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L51-L64" - }, - { - "kind": "interface", - "name": { - "name": "RetentionLease", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "period", + "name": "store_term_vectors", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L66-L68" + "specLocation": "_types/mapping/meta-fields.ts#L29-L40" }, { "kind": "interface", "name": { - "name": "IndexSegmentSort", - "namespace": "indices._types" + "name": "DynamicTemplate", + "namespace": "_types.mapping" }, "properties": [ { - "name": "field", + "name": "mapping", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Property", + "namespace": "_types.mapping" + } + } + }, + { + "name": "runtime", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Fields", - "namespace": "_types" + "name": "RuntimeField", + "namespace": "_types.mapping" } } }, { - "name": "order", + "containerProperty": true, + "name": "match", "required": false, "type": { "items": [ { "kind": "instance_of", "type": { - "name": "SegmentSortOrder", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } }, { @@ -111609,8 +115524,8 @@ "value": { "kind": "instance_of", "type": { - "name": "SegmentSortOrder", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } } @@ -111619,15 +115534,16 @@ } }, { - "name": "mode", + "containerProperty": true, + "name": "path_match", "required": false, "type": { "items": [ { "kind": "instance_of", "type": { - "name": "SegmentSortMode", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } }, { @@ -111635,8 +115551,8 @@ "value": { "kind": "instance_of", "type": { - "name": "SegmentSortMode", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } } @@ -111645,15 +115561,16 @@ } }, { - "name": "missing", + "containerProperty": true, + "name": "unmatch", "required": false, "type": { "items": [ { "kind": "instance_of", "type": { - "name": "SegmentSortMissing", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } }, { @@ -111661,174 +115578,229 @@ "value": { "kind": "instance_of", "type": { - "name": "SegmentSortMissing", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } } ], "kind": "union_of" } - } - ], - "specLocation": "indices/_types/IndexSegmentSort.ts#L22-L27" - }, - { - "kind": "interface", - "name": { - "name": "Merge", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "scheduler", + "containerProperty": true, + "name": "path_unmatch", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "MergeScheduler", - "namespace": "indices._types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "kind": "union_of" } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L346-L348" - }, - { - "kind": "interface", - "name": { - "name": "MergeScheduler", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "max_thread_count", + "containerProperty": true, + "name": "match_mapping_type", "required": false, "type": { - "generics": [ + "items": [ { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } ], - "kind": "instance_of", - "type": { - "name": "Stringified", - "namespace": "_spec_utils" - } + "kind": "union_of" } }, { - "name": "max_merge_count", + "containerProperty": true, + "name": "unmatch_mapping_type", "required": false, "type": { - "generics": [ + "items": [ { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } ], + "kind": "union_of" + } + }, + { + "containerProperty": true, + "name": "match_pattern", + "required": false, + "type": { "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "MatchType", + "namespace": "_types.mapping" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L350-L353" + "specLocation": "_types/mapping/dynamic-template.ts#L23-L43", + "variants": { + "kind": "container" + } }, { "kind": "interface", "name": { - "name": "SettingsSearch", - "namespace": "indices._types" + "name": "FieldNamesField", + "namespace": "_types.mapping" }, "properties": [ { - "name": "idle", - "required": false, + "name": "enabled", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SearchIdle", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "_types/mapping/meta-fields.ts#L42-L44" + }, + { + "kind": "interface", + "name": { + "name": "IndexField", + "namespace": "_types.mapping" + }, + "properties": [ { - "name": "slowlog", - "required": false, + "name": "enabled", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SlowlogSettings", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L248-L251" + "specLocation": "_types/mapping/meta-fields.ts#L46-L48" }, { "kind": "interface", "name": { - "name": "SearchIdle", - "namespace": "indices._types" + "name": "RoutingField", + "namespace": "_types.mapping" }, "properties": [ { - "name": "after", - "required": false, - "serverDefault": "30s", + "name": "required", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L253-L256" + "specLocation": "_types/mapping/meta-fields.ts#L50-L52" }, { "kind": "interface", "name": { - "name": "SlowlogSettings", - "namespace": "indices._types" + "name": "SizeField", + "namespace": "_types.mapping" }, "properties": [ { - "name": "level", + "name": "enabled", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/mapping/meta-fields.ts#L54-L56" + }, + { + "kind": "interface", + "name": { + "name": "SourceField", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "compress", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "source", + "name": "compress_threshold", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "reformat", + "name": "enabled", "required": false, "type": { "kind": "instance_of", @@ -111839,507 +115811,496 @@ } }, { - "name": "threshold", + "name": "excludes", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "includes", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "name": "mode", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SlowlogTresholds", - "namespace": "indices._types" + "name": "SourceFieldMode", + "namespace": "_types.mapping" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L515-L520" + "specLocation": "_types/mapping/meta-fields.ts#L58-L65" }, { "kind": "interface", "name": { - "name": "SlowlogTresholds", + "name": "DataStreamTimestamp", + "namespace": "_types.mapping" + }, + "properties": [ + { + "name": "enabled", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/mapping/TypeMapping.ts#L59-L61" + }, + { + "kind": "interface", + "name": { + "name": "AliasDefinition", "namespace": "indices._types" }, "properties": [ { - "name": "query", + "description": "Query used to limit documents the alias can access.", + "name": "filter", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SlowlogTresholdLevels", - "namespace": "indices._types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "fetch", + "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.", + "name": "index_routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SlowlogTresholdLevels", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L522-L525" - }, - { - "kind": "interface", - "name": { - "name": "SlowlogTresholdLevels", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "warn", + "description": "If `true`, the index is the write index for the alias.", + "name": "is_write_index", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "info", + "description": "Value used to route indexing and search operations to a specific shard.", + "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "debug", + "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.", + "name": "search_routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "trace", + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.", + "name": "is_hidden", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L527-L532" + "specLocation": "indices/_types/AliasDefinition.ts#L22-L54" }, { + "description": "Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.", + "inherits": { + "type": { + "name": "DataStreamLifecycle", + "namespace": "indices._types" + } + }, "kind": "interface", "name": { - "name": "IndexSettingBlocks", + "name": "DataStreamLifecycleWithRollover", "namespace": "indices._types" }, "properties": [ { - "name": "read_only", + "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.", + "name": "rollover", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "DataStreamLifecycleRolloverConditions", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/_types/DataStreamLifecycle.ts#L47-L58" + }, + { + "description": "Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.", + "kind": "interface", + "name": { + "name": "DataStreamLifecycle", + "namespace": "indices._types" + }, + "properties": [ { - "name": "read_only_allow_delete", + "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.", + "name": "data_retention", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "Duration", + "namespace": "_types" } } }, { - "name": "read", + "description": "The downsampling configuration to execute for the managed backing index after rollover.", + "name": "downsampling", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "DataStreamLifecycleDownsampling", + "namespace": "indices._types" } } }, { - "name": "write", + "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.", + "name": "enabled", "required": false, + "serverDefault": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "indices/_types/DataStreamLifecycle.ts#L25-L45" + }, + { + "kind": "interface", + "name": { + "name": "DataStreamLifecycleDownsampling", + "namespace": "indices._types" + }, + "properties": [ { - "name": "metadata", - "required": false, + "description": "The list of downsampling rounds to execute as part of this downsampling configuration", + "name": "rounds", + "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DownsamplingRound", + "namespace": "indices._types" } - ], - "kind": "instance_of", - "type": { - "name": "Stringified", - "namespace": "_spec_utils" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L262-L268" + "specLocation": "indices/_types/DataStreamLifecycleDownsampling.ts#L22-L27" }, { "kind": "interface", "name": { - "name": "SettingsAnalyze", + "name": "DownsamplingRound", "namespace": "indices._types" }, "properties": [ { - "name": "max_token_count", - "required": false, - "serverDefault": "10000", + "description": "The duration since rollover when this downsampling round should execute", + "name": "after", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "The downsample configuration to execute.", + "name": "config", + "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" + "name": "DownsampleConfig", + "namespace": "indices._types" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L243-L246" + "specLocation": "indices/_types/DownsamplingRound.ts#L23-L32" }, { "kind": "interface", "name": { - "name": "SettingsHighlight", + "name": "DownsampleConfig", "namespace": "indices._types" }, "properties": [ { - "name": "max_analyzed_offset", - "required": false, - "serverDefault": 1000000, + "description": "The interval at which to aggregate the original time series index.", + "name": "fixed_interval", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "DurationLarge", "namespace": "_types" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L238-L241" + "specLocation": "indices/_types/Downsample.ts#L22-L27" }, { "kind": "interface", "name": { - "name": "IndexRouting", + "name": "DataStreamLifecycleRolloverConditions", "namespace": "indices._types" }, "properties": [ { - "name": "allocation", + "name": "min_age", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingAllocation", - "namespace": "indices._types" + "name": "Duration", + "namespace": "_types" } } }, { - "name": "rebalance", + "name": "max_age", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingRebalance", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "indices/_types/IndexRouting.ts#L22-L25" - }, - { - "kind": "interface", - "name": { - "name": "IndexRoutingAllocation", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "enable", + "name": "min_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingAllocationOptions", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "include", + "name": "max_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingAllocationInclude", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "initial_recovery", + "name": "min_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingAllocationInitialRecovery", - "namespace": "indices._types" + "name": "ByteSize", + "namespace": "_types" } } }, { - "name": "disk", + "name": "max_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingAllocationDisk", - "namespace": "indices._types" + "name": "ByteSize", + "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexRouting.ts#L27-L32" - }, - { - "kind": "interface", - "name": { - "name": "IndexRoutingAllocationInclude", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "_tier_preference", + "name": "min_primary_shard_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { - "name": "_id", + "name": "max_primary_shard_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "ByteSize", "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexRouting.ts#L52-L55" - }, - { - "kind": "interface", - "name": { - "name": "IndexRoutingAllocationInitialRecovery", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "_id", + "name": "min_primary_shard_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexRouting.ts#L57-L59" - }, - { - "kind": "interface", - "name": { - "name": "IndexRoutingAllocationDisk", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "threshold_enabled", + "name": "max_primary_shard_docs", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } } ], - "specLocation": "indices/_types/IndexRouting.ts#L62-L64" + "specLocation": "indices/_types/DataStreamLifecycle.ts#L60-L72" }, { "kind": "interface", "name": { - "name": "IndexRoutingRebalance", - "namespace": "indices._types" + "name": "Http", + "namespace": "nodes._types" }, "properties": [ { - "name": "enable", - "required": true, + "description": "Current number of open HTTP connections for the node.", + "name": "current_open", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexRoutingRebalanceOptions", - "namespace": "indices._types" + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexRouting.ts#L34-L36" - }, - { - "kind": "interface", - "name": { - "name": "IndexSettingsLifecycle", - "namespace": "indices._types" - }, - "properties": [ + }, { - "description": "The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates.", - "name": "name", + "description": "Total number of HTTP connections opened for the node.", + "name": "total_opened", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "long", "namespace": "_types" } } }, { - "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.", - "name": "indexing_complete", + "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.", + "name": "clients", "required": false, - "serverDefault": "false", "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Client", + "namespace": "nodes._types" } - ], - "kind": "instance_of", - "type": { - "name": "Stringified", - "namespace": "_spec_utils" } } - }, + } + ], + "specLocation": "nodes/_types/Stats.ts#L669-L688" + }, + { + "kind": "interface", + "name": { + "name": "Client", + "namespace": "nodes._types" + }, + "properties": [ { - "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.", - "name": "origination_date", + "description": "Unique ID for the HTTP client.", + "name": "id", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -112349,33 +116310,33 @@ } }, { - "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.", - "name": "parse_origination_date", + "description": "Reported agent for the HTTP client.\nIf unavailable, this property is not included in the response.", + "name": "agent", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "step", + "description": "Local address for the HTTP connection.", + "name": "local_address", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettingsLifecycleStep", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "rollover_alias", + "description": "Remote address for the HTTP connection.", + "name": "remote_address", "required": false, - "serverDefault": "", "type": { "kind": "instance_of", "type": { @@ -112385,603 +116346,469 @@ } }, { - "description": "Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are\napplicable for an index).", - "name": "prefer_ilm", - "required": false, - "serverDefault": "true", - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" - } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L284-L323" - }, - { - "kind": "interface", - "name": { - "name": "IndexSettingsLifecycleStep", - "namespace": "indices._types" - }, - "properties": [ - { - "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.", - "name": "wait_time_threshold", + "description": "The URI of the client’s most recent request.", + "name": "last_uri", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L325-L331" - }, - { - "kind": "interface", - "name": { - "name": "IndexVersioning", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "created", + "description": "Time at which the client opened the connection.", + "name": "opened_time_millis", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionString", + "name": "long", "namespace": "_types" } } }, { - "name": "created_string", + "description": "Time at which the client closed the connection if the connection is closed.", + "name": "closed_time_millis", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L279-L282" - }, - { - "kind": "interface", - "name": { - "name": "Translog", - "namespace": "indices._types" - }, - "properties": [ + }, { - "description": "How often the translog is fsynced to disk and committed, regardless of write operations.\nValues less than 100ms are not allowed.", - "name": "sync_interval", + "description": "Time of the most recent request from this client.", + "name": "last_request_time_millis", "required": false, - "serverDefault": "5s", "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } }, { - "description": "Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request.", - "name": "durability", + "description": "Number of requests from this client.", + "name": "request_count", "required": false, - "serverDefault": "string", "type": { "kind": "instance_of", "type": { - "name": "TranslogDurability", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } }, { - "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.", - "name": "flush_threshold_size", + "description": "Cumulative size in bytes of all requests from this client.", + "name": "request_size_bytes", "required": false, - "serverDefault": "512mb", "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "long", "namespace": "_types" } } }, { - "name": "retention", + "description": "Value from the client’s `x-opaque-id` HTTP header.\nIf unavailable, this property is not included in the response.", + "name": "x_opaque_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TranslogRetention", - "namespace": "indices._types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L355-L377" + "specLocation": "nodes/_types/Stats.ts#L720-L767" }, { "kind": "interface", "name": { - "name": "TranslogRetention", - "namespace": "indices._types" + "name": "Ingest", + "namespace": "nodes._types" }, "properties": [ { - "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.", - "name": "size", + "description": "Contains statistics about ingest pipelines for the node.", + "name": "pipelines", "required": false, - "serverDefault": "512mb", "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "IngestStats", + "namespace": "nodes._types" + } } } }, { - "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.", - "name": "age", + "description": "Contains statistics about ingest operations for the node.", + "name": "total", "required": false, - "serverDefault": "12h", "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "IngestTotal", + "namespace": "nodes._types" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L396-L415" + "specLocation": "nodes/_types/Stats.ts#L345-L354" }, { "kind": "interface", "name": { - "name": "SettingsQueryString", - "namespace": "indices._types" + "name": "IngestStats", + "namespace": "nodes._types" }, "properties": [ { - "name": "lenient", + "description": "Total number of documents ingested during the lifetime of this node.", + "name": "count", "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - ], "kind": "instance_of", "type": { - "name": "Stringified", - "namespace": "_spec_utils" - } - } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L258-L260" - }, - { - "kind": "interface", - "name": { - "name": "IndexSettingsAnalysis", - "namespace": "indices._types" - }, - "properties": [ - { - "name": "analyzer", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Analyzer", - "namespace": "_types.analysis" - } + "name": "long", + "namespace": "_types" } } }, { - "name": "char_filter", - "required": false, + "description": "Total number of documents currently being ingested.", + "name": "current", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "CharFilter", - "namespace": "_types.analysis" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "name": "filter", - "required": false, + "description": "Total number of failed ingest operations during the lifetime of this node.", + "name": "failed", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "TokenFilter", - "namespace": "_types.analysis" - } + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" } } }, { - "name": "normalizer", - "required": false, + "description": "Total number of ingest processors.", + "name": "processors", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { - "kind": "instance_of", - "type": { - "name": "Normalizer", - "namespace": "_types.analysis" + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "KeyedProcessor", + "namespace": "nodes._types" + } } } } }, { - "name": "tokenizer", - "required": false, + "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", + "name": "time_in_millis", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Tokenizer", - "namespace": "_types.analysis" + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } } + ], + "kind": "instance_of", + "type": { + "name": "DurationValue", + "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L333-L339" - }, - { - "kind": "interface", - "name": { - "name": "IndexSettingsTimeSeries", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "end_time", - "required": false, + "availability": { + "serverless": {}, + "stack": { + "since": "8.15.0", + "stability": "stable" + } + }, + "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.", + "name": "ingested_as_first_pipeline_in_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateTime", + "name": "long", "namespace": "_types" } } }, { - "name": "start_time", - "required": false, + "availability": { + "serverless": {}, + "stack": { + "since": "8.15.0", + "stability": "stable" + } + }, + "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.", + "name": "produced_as_first_pipeline_in_bytes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateTime", + "name": "long", "namespace": "_types" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L341-L344" + "specLocation": "nodes/_types/Stats.ts#L356-L394" }, { "kind": "interface", "name": { - "name": "Queries", - "namespace": "indices._types" + "name": "KeyedProcessor", + "namespace": "nodes._types" }, "properties": [ { - "name": "cache", + "name": "stats", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CacheQueries", - "namespace": "indices._types" + "name": "Processor", + "namespace": "nodes._types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L417-L419" - }, - { - "kind": "interface", - "name": { - "name": "CacheQueries", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "enabled", - "required": true, + "name": "type", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L421-L423" + "specLocation": "nodes/_types/Stats.ts#L415-L418" }, { - "description": "Mapping Limit Settings", - "docId": "mapping-settings-limit", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-settings-limit.html", "kind": "interface", "name": { - "name": "MappingLimitSettings", - "namespace": "indices._types" + "name": "Processor", + "namespace": "nodes._types" }, "properties": [ { - "name": "coerce", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "total_fields", + "description": "Number of documents transformed by the processor.", + "name": "count", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsTotalFields", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "depth", + "description": "Number of documents currently being transformed by the processor.", + "name": "current", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsDepth", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "nested_fields", + "description": "Number of failed operations for the processor.", + "name": "failed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsNestedFields", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "nested_objects", + "description": "Time, in milliseconds, spent by the processor transforming documents.", + "name": "time_in_millis", "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "MappingLimitSettingsNestedObjects", - "namespace": "indices._types" + "name": "DurationValue", + "namespace": "_types" } } - }, + } + ], + "specLocation": "nodes/_types/Stats.ts#L420-L437" + }, + { + "kind": "interface", + "name": { + "name": "IngestTotal", + "namespace": "nodes._types" + }, + "properties": [ { - "name": "field_name_length", - "required": false, + "description": "Total number of documents ingested during the lifetime of this node.", + "name": "count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsFieldNameLength", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "dimension_fields", - "required": false, + "description": "Total number of documents currently being ingested.", + "name": "current", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsDimensionFields", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "source", - "required": false, + "description": "Total number of failed ingest operations during the lifetime of this node.", + "name": "failed", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsSourceFields", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "ignore_malformed", - "required": false, + "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", + "name": "time_in_millis", + "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, + "generics": [ { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "UnitMillis", + "namespace": "_types" } } ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "DurationValue", + "namespace": "_types" + } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L425-L439" + "specLocation": "nodes/_types/Stats.ts#L396-L413" }, { "kind": "interface", "name": { - "name": "MappingLimitSettingsTotalFields", - "namespace": "indices._types" + "name": "ThreadCount", + "namespace": "nodes._types" }, "properties": [ { - "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.", - "name": "limit", + "description": "Number of active threads in the thread pool.", + "name": "active", "required": false, - "serverDefault": "1000", "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } }, { - "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.", - "name": "ignore_dynamic_beyond_limit", + "description": "Number of tasks completed by the thread pool executor.", + "name": "completed", "required": false, - "serverDefault": "false", "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L441-L458" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsDepth", - "namespace": "indices._types" - }, - "properties": [ + }, { - "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.", - "name": "limit", + "description": "Highest number of active threads in the thread pool.", + "name": "largest", "required": false, - "serverDefault": 20, "type": { "kind": "instance_of", "type": { @@ -112989,22 +116816,11 @@ "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L460-L467" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsNestedFields", - "namespace": "indices._types" - }, - "properties": [ + }, { - "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.", - "name": "limit", + "description": "Number of tasks in queue for the thread pool.", + "name": "queue", "required": false, - "serverDefault": 50, "type": { "kind": "instance_of", "type": { @@ -113012,22 +116828,11 @@ "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L469-L477" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsNestedObjects", - "namespace": "indices._types" - }, - "properties": [ + }, { - "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.", - "name": "limit", + "description": "Number of tasks rejected by the thread pool executor.", + "name": "rejected", "required": false, - "serverDefault": 10000, "type": { "kind": "instance_of", "type": { @@ -113035,20 +116840,10 @@ "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L479-L486" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsFieldNameLength", - "namespace": "indices._types" - }, - "properties": [ + }, { - "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).", - "name": "limit", + "description": "Number of threads in the thread pool.", + "name": "threads", "required": false, "type": { "kind": "instance_of", @@ -113059,18 +116854,18 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L488-L495" + "specLocation": "nodes/_types/Stats.ts#L1075-L1100" }, { "kind": "interface", "name": { - "name": "MappingLimitSettingsDimensionFields", - "namespace": "indices._types" + "name": "Scripting", + "namespace": "nodes._types" }, "properties": [ { - "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.", - "name": "limit", + "description": "Total number of times the script cache has evicted old data.", + "name": "cache_evictions", "required": false, "type": { "kind": "instance_of", @@ -113079,40 +116874,80 @@ "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L497-L503" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsSourceFields", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "mode", - "required": true, + "description": "Total number of inline script compilations performed by the node.", + "name": "compilations", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SourceMode", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" + } + } + }, + { + "description": "Contains this recent history of script compilations.", + "name": "compilations_history", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + }, + { + "description": "Total number of times the script compilation circuit breaker has limited inline script compilations.", + "name": "compilation_limit_triggered", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "contexts", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Context", + "namespace": "nodes._types" + } } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L505-L507" + "specLocation": "nodes/_types/Stats.ts#L1048-L1066" }, { "kind": "interface", "name": { - "name": "IndexingSlowlogSettings", - "namespace": "indices._types" + "name": "Context", + "namespace": "nodes._types" }, "properties": [ { - "name": "level", + "name": "context", "required": false, "type": { "kind": "instance_of", @@ -113123,162 +116958,188 @@ } }, { - "name": "source", + "name": "compilations", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "reformat", + "name": "cache_evictions", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" + } + } + }, + { + "name": "compilation_limit_triggered", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "nodes/_types/Stats.ts#L1068-L1073" + }, + { + "kind": "interface", + "name": { + "name": "IndexState", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "aliases", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Alias", + "namespace": "indices._types" + } + } + } + }, + { + "name": "mappings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "name": "threshold", + "name": "settings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexingSlowlogTresholds", + "name": "IndexSettings", "namespace": "indices._types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L588-L593" - }, - { - "kind": "interface", - "name": { - "name": "IndexingSlowlogTresholds", - "namespace": "indices._types" - }, - "properties": [ + }, { - "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.", - "docId": "index-modules-slowlog-slowlog", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-slowlog.html#index-slow-log", - "name": "index", + "description": "Default settings, included when the request's `include_default` is `true`.", + "name": "defaults", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SlowlogTresholdLevels", + "name": "IndexSettings", "namespace": "indices._types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L595-L602" - }, - { - "kind": "interface", - "name": { - "name": "IndexingPressure", - "namespace": "indices._types" - }, - "properties": [ + }, { - "name": "memory", - "required": true, + "name": "data_stream", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexingPressureMemory", - "namespace": "indices._types" + "name": "DataStreamName", + "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L575-L577" - }, - { - "kind": "interface", - "name": { - "name": "IndexingPressureMemory", - "namespace": "indices._types" - }, - "properties": [ + }, { - "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.", - "name": "limit", + "availability": { + "serverless": { + "stability": "stable" + }, + "stack": { + "since": "8.11.0", + "stability": "stable" + } + }, + "description": "Data stream lifecycle applicable if this is a data stream.", + "name": "lifecycle", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "DataStreamLifecycle", + "namespace": "indices._types" } } } ], - "specLocation": "indices/_types/IndexSettings.ts#L579-L586" + "specLocation": "indices/_types/IndexState.ts#L27-L40" }, { "kind": "interface", "name": { - "name": "Storage", + "name": "Alias", "namespace": "indices._types" }, "properties": [ { - "name": "type", - "required": true, + "description": "Query used to limit documents the alias can access.", + "name": "filter", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "StorageType", - "namespace": "indices._types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "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.", - "name": "allow_mmap", + "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.", + "name": "index_routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Routing", + "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L534-L543" - }, - { - "kind": "interface", - "name": { - "name": "TypeMapping", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "all_field", + "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.", + "name": "is_hidden", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "AllField", - "namespace": "_types.mapping" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "date_detection", + "description": "If `true`, the index is the write index for the alias.", + "name": "is_write_index", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -113288,93 +117149,86 @@ } }, { - "name": "dynamic", + "description": "Value used to route indexing and search operations to a specific shard.", + "name": "routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DynamicMapping", - "namespace": "_types.mapping" + "name": "Routing", + "namespace": "_types" } } }, { - "name": "dynamic_date_formats", + "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.", + "name": "search_routing", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "Routing", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/Alias.ts#L23-L53" + }, + { + "kind": "interface", + "name": { + "name": "Connector", + "namespace": "connector._types" + }, + "properties": [ { - "name": "dynamic_templates", + "name": "api_key_id", "required": false, "type": { - "kind": "array_of", - "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": true, - "value": { - "kind": "instance_of", - "type": { - "name": "DynamicTemplate", - "namespace": "_types.mapping" - } - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_field_names", + "name": "api_key_secret_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FieldNamesField", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "index_field", - "required": false, + "name": "configuration", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexField", - "namespace": "_types.mapping" + "name": "ConnectorConfiguration", + "namespace": "connector._types" } } }, { - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "_meta", - "required": false, + "name": "custom_scheduling", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Metadata", - "namespace": "_types" + "name": "ConnectorCustomScheduling", + "namespace": "connector._types" } } }, { - "name": "numeric_detection", - "required": false, + "name": "deleted", + "required": true, "type": { "kind": "instance_of", "type": { @@ -113384,462 +117238,305 @@ } }, { - "name": "properties", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "PropertyName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Property", - "namespace": "_types.mapping" - } - } - } - }, - { - "name": "_routing", + "name": "description", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RoutingField", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "_size", + "name": "error", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "SizeField", - "namespace": "_types.mapping" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "name": "_source", + "name": "features", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SourceField", - "namespace": "_types.mapping" + "name": "ConnectorFeatures", + "namespace": "connector._types" } } }, { - "name": "runtime", - "required": false, + "name": "filtering", + "required": true, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, + "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "RuntimeField", - "namespace": "_types.mapping" + "name": "FilteringConfig", + "namespace": "connector._types" } } } }, { - "name": "enabled", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "name": "subobjects", + "name": "index_name", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Subobjects", - "namespace": "_types.mapping" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "name": "_data_stream_timestamp", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataStreamTimestamp", - "namespace": "_types.mapping" - } - } - } - ], - "specLocation": "_types/mapping/TypeMapping.ts#L34-L57" - }, - { - "kind": "interface", - "name": { - "name": "AllField", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "analyzer", + "name": "is_native", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "enabled", - "required": true, + "name": "language", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "omit_norms", - "required": true, + "name": "last_access_control_sync_error", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "search_analyzer", - "required": true, + "name": "last_access_control_sync_scheduled_at", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "name": "similarity", - "required": true, + "name": "last_access_control_sync_status", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SyncStatus", + "namespace": "connector._types" } } }, { - "name": "store", - "required": true, + "name": "last_deleted_document_count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "store_term_vector_offsets", - "required": true, + "name": "last_incremental_sync_scheduled_at", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "name": "store_term_vector_payloads", - "required": true, + "name": "last_indexed_document_count", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "store_term_vector_positions", - "required": true, + "name": "last_seen", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "name": "store_term_vectors", - "required": true, + "name": "last_sync_error", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - } - ], - "specLocation": "_types/mapping/meta-fields.ts#L29-L40" - }, - { - "kind": "interface", - "name": { - "name": "DynamicTemplate", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "mapping", + "name": "last_sync_scheduled_at", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Property", - "namespace": "_types.mapping" + "name": "DateTime", + "namespace": "_types" } } }, { - "name": "runtime", + "name": "last_sync_status", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RuntimeField", - "namespace": "_types.mapping" + "name": "SyncStatus", + "namespace": "connector._types" } } }, { - "containerProperty": true, - "name": "match", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" - } - }, - { - "containerProperty": true, - "name": "path_match", + "name": "last_synced", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } } }, { - "containerProperty": true, - "name": "unmatch", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "name": "name", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "containerProperty": true, - "name": "path_unmatch", + "name": "pipeline", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "IngestPipelineParams", + "namespace": "connector._types" + } } }, { - "containerProperty": true, - "name": "match_mapping_type", - "required": false, + "name": "scheduling", + "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "SchedulingConfiguration", + "namespace": "connector._types" + } } }, { - "containerProperty": true, - "name": "unmatch_mapping_type", + "name": "service_type", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { - "containerProperty": true, - "name": "match_pattern", - "required": false, + "name": "status", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "MatchType", - "namespace": "_types.mapping" + "name": "ConnectorStatus", + "namespace": "connector._types" } } - } - ], - "specLocation": "_types/mapping/dynamic-template.ts#L23-L43", - "variants": { - "kind": "container" - } - }, - { - "kind": "interface", - "name": { - "name": "FieldNamesField", - "namespace": "_types.mapping" - }, - "properties": [ + }, { - "name": "enabled", + "name": "sync_cursor", + "required": false, + "type": { + "kind": "user_defined_value" + } + }, + { + "name": "sync_now", "required": true, "type": { "kind": "instance_of", @@ -113850,38 +117547,74 @@ } } ], - "specLocation": "_types/mapping/meta-fields.ts#L42-L44" + "specLocation": "connector/_types/Connector.ts#L252-L284" }, { "kind": "interface", "name": { - "name": "IndexField", - "namespace": "_types.mapping" + "name": "ConnectorFeatures", + "namespace": "connector._types" }, "properties": [ { - "name": "enabled", - "required": true, + "description": "Indicates whether document-level security is enabled.", + "name": "document_level_security", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "FeatureEnabled", + "namespace": "connector._types" + } + } + }, + { + "description": "Indicates whether incremental syncs are enabled.", + "name": "incremental_sync", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FeatureEnabled", + "namespace": "connector._types" + } + } + }, + { + "description": "Indicates whether managed connector API keys are enabled.", + "name": "native_connector_api_keys", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FeatureEnabled", + "namespace": "connector._types" + } + } + }, + { + "name": "sync_rules", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "SyncRulesFeature", + "namespace": "connector._types" } } } ], - "specLocation": "_types/mapping/meta-fields.ts#L46-L48" + "specLocation": "connector/_types/Connector.ts#L230-L244" }, { "kind": "interface", "name": { - "name": "RoutingField", - "namespace": "_types.mapping" + "name": "FeatureEnabled", + "namespace": "connector._types" }, "properties": [ { - "name": "required", + "name": "enabled", "required": true, "type": { "kind": "instance_of", @@ -113892,49 +117625,62 @@ } } ], - "specLocation": "_types/mapping/meta-fields.ts#L50-L52" + "specLocation": "connector/_types/Connector.ts#L215-L217" }, { "kind": "interface", "name": { - "name": "SizeField", - "namespace": "_types.mapping" + "name": "SyncRulesFeature", + "namespace": "connector._types" }, "properties": [ { - "name": "enabled", - "required": true, + "description": "Indicates whether advanced sync rules are enabled.", + "name": "advanced", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "FeatureEnabled", + "namespace": "connector._types" + } + } + }, + { + "description": "Indicates whether basic sync rules are enabled.", + "name": "basic", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FeatureEnabled", + "namespace": "connector._types" } } } ], - "specLocation": "_types/mapping/meta-fields.ts#L54-L56" + "specLocation": "connector/_types/Connector.ts#L219-L228" }, { "kind": "interface", "name": { - "name": "SourceField", - "namespace": "_types.mapping" + "name": "FilteringConfig", + "namespace": "connector._types" }, "properties": [ { - "name": "compress", - "required": false, + "name": "active", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "FilteringRules", + "namespace": "connector._types" } } }, { - "name": "compress_threshold", + "name": "domain", "required": false, "type": { "kind": "instance_of", @@ -113945,348 +117691,296 @@ } }, { - "name": "enabled", - "required": false, + "name": "draft", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "FilteringRules", + "namespace": "connector._types" } } - }, + } + ], + "specLocation": "connector/_types/Connector.ts#L209-L213" + }, + { + "kind": "interface", + "name": { + "name": "FilteringRules", + "namespace": "connector._types" + }, + "properties": [ { - "name": "excludes", - "required": false, + "name": "advanced_snippet", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "FilteringAdvancedSnippet", + "namespace": "connector._types" } } }, { - "name": "includes", - "required": false, + "name": "rules", + "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "FilteringRule", + "namespace": "connector._types" } } } }, { - "name": "mode", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SourceFieldMode", - "namespace": "_types.mapping" - } - } - } - ], - "specLocation": "_types/mapping/meta-fields.ts#L58-L65" - }, - { - "kind": "interface", - "name": { - "name": "DataStreamTimestamp", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "enabled", + "name": "validation", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "FilteringRulesValidation", + "namespace": "connector._types" } } } ], - "specLocation": "_types/mapping/TypeMapping.ts#L59-L61" + "specLocation": "connector/_types/Connector.ts#L203-L207" }, { "kind": "interface", "name": { - "name": "AliasDefinition", - "namespace": "indices._types" + "name": "FilteringAdvancedSnippet", + "namespace": "connector._types" }, "properties": [ { - "description": "Query used to limit documents the alias can access.", - "name": "filter", + "name": "created_at", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "DateTime", + "namespace": "_types" } } }, { - "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.", - "name": "index_routing", + "name": "updated_at", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "description": "If `true`, the index is the write index for the alias.", - "name": "is_write_index", + "name": "value", + "required": true, + "type": { + "kind": "user_defined_value" + } + } + ], + "specLocation": "connector/_types/Connector.ts#L192-L196" + }, + { + "kind": "interface", + "name": { + "name": "FilteringRule", + "namespace": "connector._types" + }, + "properties": [ + { + "name": "created_at", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "description": "Value used to route indexing and search operations to a specific shard.", - "name": "routing", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.", - "name": "search_routing", - "required": false, + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.", - "name": "is_hidden", - "required": false, - "serverDefault": false, + "name": "order", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/AliasDefinition.ts#L22-L54" - }, - { - "description": "Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.", - "inherits": { - "type": { - "name": "DataStreamLifecycle", - "namespace": "indices._types" - } - }, - "kind": "interface", - "name": { - "name": "DataStreamLifecycleWithRollover", - "namespace": "indices._types" - }, - "properties": [ + }, { - "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.", - "name": "rollover", - "required": false, + "name": "policy", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataStreamLifecycleRolloverConditions", - "namespace": "indices._types" + "name": "FilteringPolicy", + "namespace": "connector._types" } } - } - ], - "specLocation": "indices/_types/DataStreamLifecycle.ts#L47-L58" - }, - { - "description": "Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.", - "kind": "interface", - "name": { - "name": "DataStreamLifecycle", - "namespace": "indices._types" - }, - "properties": [ + }, { - "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.", - "name": "data_retention", - "required": false, + "name": "rule", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "FilteringRuleRule", + "namespace": "connector._types" } } }, { - "description": "The downsampling configuration to execute for the managed backing index after rollover.", - "name": "downsampling", + "name": "updated_at", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamLifecycleDownsampling", - "namespace": "indices._types" + "name": "DateTime", + "namespace": "_types" } } }, { - "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.", - "name": "enabled", - "required": false, - "serverDefault": true, + "name": "value", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/DataStreamLifecycle.ts#L25-L45" + "specLocation": "connector/_types/Connector.ts#L170-L179" }, { "kind": "interface", "name": { - "name": "DataStreamLifecycleDownsampling", - "namespace": "indices._types" + "name": "FilteringRulesValidation", + "namespace": "connector._types" }, "properties": [ { - "description": "The list of downsampling rounds to execute as part of this downsampling configuration", - "name": "rounds", + "name": "errors", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "DownsamplingRound", - "namespace": "indices._types" + "name": "FilteringValidation", + "namespace": "connector._types" } } } - } - ], - "specLocation": "indices/_types/DataStreamLifecycleDownsampling.ts#L22-L27" - }, - { - "kind": "interface", - "name": { - "name": "DownsamplingRound", - "namespace": "indices._types" - }, - "properties": [ - { - "description": "The duration since rollover when this downsampling round should execute", - "name": "after", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } }, { - "description": "The downsample configuration to execute.", - "name": "config", + "name": "state", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DownsampleConfig", - "namespace": "indices._types" + "name": "FilteringValidationState", + "namespace": "connector._types" } } } ], - "specLocation": "indices/_types/DownsamplingRound.ts#L23-L32" + "specLocation": "connector/_types/Connector.ts#L198-L201" }, { "kind": "interface", "name": { - "name": "DownsampleConfig", - "namespace": "indices._types" + "name": "FilteringValidation", + "namespace": "connector._types" }, "properties": [ { - "description": "The interval at which to aggregate the original time series index.", - "name": "fixed_interval", + "name": "ids", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "DurationLarge", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + }, + { + "name": "messages", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } ], - "specLocation": "indices/_types/Downsample.ts#L22-L27" + "specLocation": "connector/_types/Connector.ts#L181-L184" }, { "kind": "interface", "name": { - "name": "DataStreamLifecycleRolloverConditions", - "namespace": "indices._types" + "name": "IngestPipelineParams", + "namespace": "connector._types" }, "properties": [ { - "name": "min_age", - "required": false, + "name": "extract_binary_content", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "max_age", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { @@ -114296,203 +117990,181 @@ } }, { - "name": "min_docs", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "max_docs", - "required": false, + "name": "reduce_whitespace", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "min_size", - "required": false, + "name": "run_ml_inference", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "connector/_types/Connector.ts#L148-L153" + }, + { + "kind": "interface", + "name": { + "name": "SchedulingConfiguration", + "namespace": "connector._types" + }, + "properties": [ { - "name": "max_size", + "name": "access_control", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "ConnectorScheduling", + "namespace": "connector._types" } } }, { - "name": "min_primary_shard_size", + "name": "full", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "ConnectorScheduling", + "namespace": "connector._types" } } }, { - "name": "max_primary_shard_size", + "name": "incremental", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "ConnectorScheduling", + "namespace": "connector._types" } } - }, + } + ], + "specLocation": "connector/_types/Connector.ts#L246-L250" + }, + { + "kind": "interface", + "name": { + "name": "ConnectorScheduling", + "namespace": "connector._types" + }, + "properties": [ { - "name": "min_primary_shard_docs", - "required": false, + "name": "enabled", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "max_primary_shard_docs", - "required": false, + "description": "The interval is expressed using the crontab syntax", + "name": "interval", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/DataStreamLifecycle.ts#L60-L72" + "specLocation": "connector/_types/Connector.ts#L106-L110" }, { "kind": "interface", "name": { - "name": "Http", - "namespace": "nodes._types" + "name": "ConnectorSyncJob", + "namespace": "connector._types" }, "properties": [ { - "description": "Current number of open HTTP connections for the node.", - "name": "current_open", + "name": "cancelation_requested_at", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "DateTime", "namespace": "_types" } } }, { - "description": "Total number of HTTP connections opened for the node.", - "name": "total_opened", + "name": "canceled_at", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "DateTime", "namespace": "_types" } } }, { - "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.", - "name": "clients", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Client", - "namespace": "nodes._types" - } - } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L669-L688" - }, - { - "kind": "interface", - "name": { - "name": "Client", - "namespace": "nodes._types" - }, - "properties": [ - { - "description": "Unique ID for the HTTP client.", - "name": "id", + "name": "completed_at", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "DateTime", "namespace": "_types" } } }, { - "description": "Reported agent for the HTTP client.\nIf unavailable, this property is not included in the response.", - "name": "agent", - "required": false, + "name": "connector", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "SyncJobConnectorReference", + "namespace": "connector._types" } } }, { - "description": "Local address for the HTTP connection.", - "name": "local_address", - "required": false, + "name": "created_at", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "DateTime", + "namespace": "_types" } } }, { - "description": "Remote address for the HTTP connection.", - "name": "remote_address", - "required": false, + "name": "deleted_document_count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "description": "The URI of the client’s most recent request.", - "name": "last_uri", + "name": "error", "required": false, "type": { "kind": "instance_of", @@ -114503,21 +118175,19 @@ } }, { - "description": "Time at which the client opened the connection.", - "name": "opened_time_millis", - "required": false, + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } }, { - "description": "Time at which the client closed the connection if the connection is closed.", - "name": "closed_time_millis", - "required": false, + "name": "indexed_document_count", + "required": true, "type": { "kind": "instance_of", "type": { @@ -114527,9 +118197,8 @@ } }, { - "description": "Time of the most recent request from this client.", - "name": "last_request_time_millis", - "required": false, + "name": "indexed_document_volume", + "required": true, "type": { "kind": "instance_of", "type": { @@ -114539,55 +118208,30 @@ } }, { - "description": "Number of requests from this client.", - "name": "request_count", - "required": false, + "name": "job_type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "SyncJobType", + "namespace": "connector._types" } } }, { - "description": "Cumulative size in bytes of all requests from this client.", - "name": "request_size_bytes", + "name": "last_seen", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "DateTime", "namespace": "_types" } } }, { - "description": "Value from the client’s `x-opaque-id` HTTP header.\nIf unavailable, this property is not included in the response.", - "name": "x_opaque_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L720-L767" - }, - { - "kind": "interface", - "name": { - "name": "Ingest", - "namespace": "nodes._types" - }, - "properties": [ - { - "description": "Contains statistics about ingest pipelines for the node.", - "name": "pipelines", - "required": false, + "name": "metadata", + "required": true, "type": { "key": { "kind": "instance_of", @@ -114599,51 +118243,34 @@ "kind": "dictionary_of", "singleKey": false, "value": { - "kind": "instance_of", - "type": { - "name": "IngestStats", - "namespace": "nodes._types" - } + "kind": "user_defined_value" } } }, { - "description": "Contains statistics about ingest operations for the node.", - "name": "total", + "name": "started_at", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IngestTotal", - "namespace": "nodes._types" + "name": "DateTime", + "namespace": "_types" } } - } - ], - "specLocation": "nodes/_types/Stats.ts#L345-L354" - }, - { - "kind": "interface", - "name": { - "name": "IngestStats", - "namespace": "nodes._types" - }, - "properties": [ + }, { - "description": "Total number of documents ingested during the lifetime of this node.", - "name": "count", + "name": "status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "SyncStatus", + "namespace": "connector._types" } } }, { - "description": "Total number of documents currently being ingested.", - "name": "current", + "name": "total_document_count", "required": true, "type": { "kind": "instance_of", @@ -114654,126 +118281,73 @@ } }, { - "description": "Total number of failed ingest operations during the lifetime of this node.", - "name": "failed", + "name": "trigger_method", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "SyncJobTriggerMethod", + "namespace": "connector._types" } } }, { - "description": "Total number of ingest processors.", - "name": "processors", - "required": true, + "name": "worker_hostname", + "required": false, "type": { - "kind": "array_of", - "value": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "KeyedProcessor", - "namespace": "nodes._types" - } - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "connector/_types/SyncJob.ts#L53-L72" + }, + { + "kind": "interface", + "name": { + "name": "SyncJobConnectorReference", + "namespace": "connector._types" + }, + "properties": [ { - "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", - "name": "time_in_millis", + "name": "configuration", "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", - "namespace": "_types" + "name": "ConnectorConfiguration", + "namespace": "connector._types" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "8.15.0", - "stability": "stable" - } - }, - "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.", - "name": "ingested_as_first_pipeline_in_bytes", + "name": "filtering", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "FilteringRules", + "namespace": "connector._types" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "8.15.0", - "stability": "stable" - } - }, - "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.", - "name": "produced_as_first_pipeline_in_bytes", + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } - } - ], - "specLocation": "nodes/_types/Stats.ts#L356-L394" - }, - { - "kind": "interface", - "name": { - "name": "KeyedProcessor", - "namespace": "nodes._types" - }, - "properties": [ - { - "name": "stats", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Processor", - "namespace": "nodes._types" - } - } }, { - "name": "type", - "required": false, + "name": "index_name", + "required": true, "type": { "kind": "instance_of", "type": { @@ -114781,154 +118355,84 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "nodes/_types/Stats.ts#L415-L418" - }, - { - "kind": "interface", - "name": { - "name": "Processor", - "namespace": "nodes._types" - }, - "properties": [ + }, { - "description": "Number of documents transformed by the processor.", - "name": "count", + "name": "language", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Number of documents currently being transformed by the processor.", - "name": "current", + "name": "pipeline", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "IngestPipelineParams", + "namespace": "connector._types" } } }, { - "description": "Number of failed operations for the processor.", - "name": "failed", - "required": false, + "name": "service_type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Time, in milliseconds, spent by the processor transforming documents.", - "name": "time_in_millis", + "name": "sync_cursor", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } + "kind": "user_defined_value" } } ], - "specLocation": "nodes/_types/Stats.ts#L420-L437" + "specLocation": "connector/_types/SyncJob.ts#L31-L40" }, { "kind": "interface", "name": { - "name": "IngestTotal", - "namespace": "nodes._types" + "name": "WriteResponseBase", + "namespace": "_types" }, "properties": [ { - "description": "Total number of documents ingested during the lifetime of this node.", - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total number of documents currently being ingested.", - "name": "current", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "Total number of failed ingest operations during the lifetime of this node.", - "name": "failed", + "description": "The unique identifier for the added document.", + "name": "_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } }, { - "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", - "name": "time_in_millis", - "required": true, - "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "kind": "instance_of", - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - } - ], - "specLocation": "nodes/_types/Stats.ts#L396-L413" - }, - { - "kind": "interface", - "name": { - "name": "ThreadCount", - "namespace": "nodes._types" - }, - "properties": [ + "description": "The name of the index the document was added to.", + "name": "_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, { - "description": "Number of active threads in the thread pool.", - "name": "active", + "description": "The primary term assigned to the document for the indexing operation.", + "name": "_primary_term", "required": false, "type": { "kind": "instance_of", @@ -114939,172 +118443,132 @@ } }, { - "description": "Number of tasks completed by the thread pool executor.", - "name": "completed", - "required": false, + "description": "The result of the indexing operation: `created` or `updated`.", + "name": "result", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Result", "namespace": "_types" } } }, { - "description": "Highest number of active threads in the thread pool.", - "name": "largest", + "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.", + "name": "_seq_no", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "SequenceNumber", "namespace": "_types" } } }, { - "description": "Number of tasks in queue for the thread pool.", - "name": "queue", - "required": false, + "description": "Information about the replication process of the operation.", + "name": "_shards", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "ShardStatistics", "namespace": "_types" } } }, { - "description": "Number of tasks rejected by the thread pool executor.", - "name": "rejected", - "required": false, + "description": "The document version, which is incremented each time the document is updated.", + "name": "_version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "VersionNumber", "namespace": "_types" } } }, { - "description": "Number of threads in the thread pool.", - "name": "threads", + "name": "forced_refresh", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "nodes/_types/Stats.ts#L1075-L1100" + "specLocation": "_types/Base.ts#L36-L67" }, { "kind": "interface", "name": { - "name": "Scripting", - "namespace": "nodes._types" + "name": "BulkIndexByScrollFailure", + "namespace": "_types" }, "properties": [ { - "description": "Total number of times the script cache has evicted old data.", - "name": "cache_evictions", - "required": false, + "name": "cause", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "ErrorCause", "namespace": "_types" } } }, { - "description": "Total number of inline script compilations performed by the node.", - "name": "compilations", - "required": false, + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Id", "namespace": "_types" } } }, { - "description": "Contains this recent history of script compilations.", - "name": "compilations_history", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - }, - { - "description": "Total number of times the script compilation circuit breaker has limited inline script compilations.", - "name": "compilation_limit_triggered", - "required": false, + "name": "index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "contexts", - "required": false, + "name": "status", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Context", - "namespace": "nodes._types" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "nodes/_types/Stats.ts#L1048-L1066" + "specLocation": "_types/Errors.ts#L60-L65" }, { "kind": "interface", "name": { - "name": "Context", - "namespace": "nodes._types" + "name": "Retries", + "namespace": "_types" }, "properties": [ { - "name": "context", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "compilations", - "required": false, + "description": "The number of bulk actions retried.", + "name": "bulk", + "required": true, "type": { "kind": "instance_of", "type": { @@ -115114,8 +118578,9 @@ } }, { - "name": "cache_evictions", - "required": false, + "description": "The number of search actions retried.", + "name": "search", + "required": true, "type": { "kind": "instance_of", "type": { @@ -115123,565 +118588,617 @@ "namespace": "_types" } } - }, + } + ], + "specLocation": "_types/Retries.ts#L22-L31" + }, + { + "kind": "interface", + "name": { + "name": "ExecuteEnrichPolicyStatus", + "namespace": "enrich.execute_policy" + }, + "properties": [ { - "name": "compilation_limit_triggered", - "required": false, + "name": "phase", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "EnrichPolicyPhase", + "namespace": "enrich.execute_policy" } } } ], - "specLocation": "nodes/_types/Stats.ts#L1068-L1073" + "specLocation": "enrich/execute_policy/types.ts#L20-L22" }, { "kind": "interface", "name": { - "name": "IndexState", - "namespace": "indices._types" + "name": "Summary", + "namespace": "enrich._types" }, "properties": [ { - "name": "aliases", - "required": false, + "name": "config", + "required": true, "type": { "key": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "PolicyType", + "namespace": "enrich._types" } }, "kind": "dictionary_of", - "singleKey": false, + "singleKey": true, "value": { "kind": "instance_of", "type": { - "name": "Alias", - "namespace": "indices._types" + "name": "Policy", + "namespace": "enrich._types" } } } - }, - { - "name": "mappings", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" - } - } - }, - { - "name": "settings", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexSettings", - "namespace": "indices._types" - } - } - }, - { - "description": "Default settings, included when the request's `include_default` is `true`.", - "name": "defaults", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexSettings", - "namespace": "indices._types" - } - } - }, - { - "name": "data_stream", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataStreamName", - "namespace": "_types" - } - } - }, - { - "availability": { - "serverless": { - "stability": "stable" - }, - "stack": { - "since": "8.11.0", - "stability": "stable" - } - }, - "description": "Data stream lifecycle applicable if this is a data stream.", - "name": "lifecycle", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataStreamLifecycle", - "namespace": "indices._types" - } - } } ], - "specLocation": "indices/_types/IndexState.ts#L27-L40" + "specLocation": "enrich/_types/Policy.ts#L24-L26" }, { "kind": "interface", "name": { - "name": "Alias", - "namespace": "indices._types" + "name": "Policy", + "namespace": "enrich._types" }, "properties": [ { - "description": "Query used to limit documents the alias can access.", - "name": "filter", - "required": false, + "name": "enrich_fields", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "Fields", + "namespace": "_types" } } }, { - "description": "Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.", - "name": "index_routing", - "required": false, + "name": "indices", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Routing", + "name": "Indices", "namespace": "_types" } } }, { - "description": "If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value.", - "name": "is_hidden", - "required": false, - "serverDefault": false, + "name": "match_field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "description": "If `true`, the index is the write index for the alias.", - "name": "is_write_index", + "name": "query", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "description": "Value used to route indexing and search operations to a specific shard.", - "name": "routing", + "name": "name", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", + "name": "Name", "namespace": "_types" } } }, { - "description": "Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.", - "name": "search_routing", + "name": "elasticsearch_version", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/Alias.ts#L23-L53" + "specLocation": "enrich/_types/Policy.ts#L34-L41" }, { + "generics": [ + { + "name": "TEvent", + "namespace": "eql._types.EqlSearchResponseBase" + } + ], "kind": "interface", "name": { - "name": "Connector", - "namespace": "connector._types" + "name": "EqlSearchResponseBase", + "namespace": "eql._types" }, "properties": [ { - "name": "api_key_id", + "description": "Identifier for the search.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "name": "api_key_secret_id", + "description": "If true, the response does not contain complete search results.", + "name": "is_partial", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "configuration", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ConnectorConfiguration", - "namespace": "connector._types" - } - } - }, - { - "name": "custom_scheduling", - "required": true, + "description": "If true, the search request is still executing.", + "name": "is_running", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ConnectorCustomScheduling", - "namespace": "connector._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "deleted", - "required": true, + "description": "Milliseconds it took Elasticsearch to execute the request.", + "name": "took", + "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "DurationValue", + "namespace": "_types" } } }, { - "name": "description", + "description": "If true, the request timed out before completion.", + "name": "timed_out", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "error", - "required": false, + "description": "Contains matching events and sequences. Also contains related metadata.", + "name": "hits", + "required": true, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, + "generics": [ { "kind": "instance_of", "type": { - "name": "null", - "namespace": "_builtins" + "name": "TEvent", + "namespace": "eql._types.EqlSearchResponseBase" } } ], - "kind": "union_of" - } - }, - { - "name": "features", - "required": false, - "type": { "kind": "instance_of", "type": { - "name": "ConnectorFeatures", - "namespace": "connector._types" + "name": "EqlHits", + "namespace": "eql._types" } } }, { - "name": "filtering", - "required": true, + "description": "Contains information about shard failures (if any), in case allow_partial_search_results=true", + "name": "shard_failures", + "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "FilteringConfig", - "namespace": "connector._types" + "name": "ShardFailure", + "namespace": "_types" } } } - }, + } + ], + "specLocation": "eql/_types/EqlSearchResponseBase.ts#L25-L54" + }, + { + "generics": [ { - "name": "id", + "name": "TEvent", + "namespace": "eql._types.EqlHits" + } + ], + "kind": "interface", + "name": { + "name": "EqlHits", + "namespace": "eql._types" + }, + "properties": [ + { + "description": "Metadata about the number of matching events or sequences.", + "name": "total", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "TotalHits", + "namespace": "_global.search._types" } } }, { - "name": "index_name", + "description": "Contains events matching the query. Each object represents a matching event.", + "name": "events", "required": false, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TEvent", + "namespace": "eql._types.EqlHits" + } } + ], + "kind": "instance_of", + "type": { + "name": "HitsEvent", + "namespace": "eql._types" } - ], - "kind": "union_of" - } - }, - { - "name": "is_native", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" } } }, { - "name": "language", + "description": "Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.", + "docId": "eql-sequences", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", + "name": "sequences", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TEvent", + "namespace": "eql._types.EqlHits" + } + } + ], + "kind": "instance_of", + "type": { + "name": "HitsSequence", + "namespace": "eql._types" + } } } - }, + } + ], + "specLocation": "eql/_types/EqlHits.ts#L25-L39" + }, + { + "generics": [ + { + "name": "TEvent", + "namespace": "eql._types.HitsEvent" + } + ], + "kind": "interface", + "name": { + "name": "HitsEvent", + "namespace": "eql._types" + }, + "properties": [ { - "name": "last_access_control_sync_error", - "required": false, + "description": "Name of the index containing the event.", + "name": "_index", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } }, { - "name": "last_access_control_sync_scheduled_at", - "required": false, + "description": "Unique identifier for the event. This ID is only unique within the index.", + "name": "_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateTime", + "name": "Id", "namespace": "_types" } } }, { - "name": "last_access_control_sync_status", - "required": false, + "description": "Original JSON body passed for the event at index time.", + "name": "_source", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "SyncStatus", - "namespace": "connector._types" + "name": "TEvent", + "namespace": "eql._types.HitsEvent" } } }, { - "name": "last_deleted_document_count", + "description": "Set to `true` for events in a timespan-constrained sequence that do not meet a given condition.", + "docId": "eql-missing-events", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-missing-events", + "name": "missing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "last_incremental_sync_scheduled_at", + "name": "fields", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "array_of", + "value": { + "kind": "user_defined_value" + } } } - }, + } + ], + "specLocation": "eql/_types/EqlHits.ts#L41-L54" + }, + { + "generics": [ { - "name": "last_indexed_document_count", - "required": false, + "name": "TEvent", + "namespace": "eql._types.HitsSequence" + } + ], + "kind": "interface", + "name": { + "name": "HitsSequence", + "namespace": "eql._types" + }, + "properties": [ + { + "description": "Contains events matching the query. Each object represents a matching event.", + "name": "events", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "kind": "array_of", + "value": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "TEvent", + "namespace": "eql._types.HitsSequence" + } + } + ], + "kind": "instance_of", + "type": { + "name": "HitsEvent", + "namespace": "eql._types" + } } } }, { - "name": "last_seen", + "description": "Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.", + "docId": "eql-sequences", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", + "name": "join_keys", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "user_defined_value" } } - }, + } + ], + "specLocation": "eql/_types/EqlHits.ts#L56-L64" + }, + { + "kind": "interface", + "name": { + "name": "TableValuesContainer", + "namespace": "esql._types" + }, + "properties": [ { - "name": "last_sync_error", + "name": "integer", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TableValuesIntegerValue", + "namespace": "esql._types" + } } } }, { - "name": "last_sync_scheduled_at", + "name": "keyword", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TableValuesKeywordValue", + "namespace": "esql._types" + } } } }, { - "name": "last_sync_status", + "name": "long", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "SyncStatus", - "namespace": "connector._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TableValuesLongValue", + "namespace": "esql._types" + } } } }, { - "name": "last_synced", + "name": "double", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TableValuesLongDouble", + "namespace": "esql._types" + } } } - }, + } + ], + "specLocation": "esql/_types/TableValuesContainer.ts#L22-L28", + "variants": { + "kind": "container" + } + }, + { + "kind": "interface", + "name": { + "name": "FieldCapability", + "namespace": "_global.field_caps" + }, + "properties": [ { - "name": "name", - "required": false, + "description": "Whether this field can be aggregated on all indices.", + "name": "aggregatable", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "pipeline", + "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.", + "name": "indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IngestPipelineParams", - "namespace": "connector._types" + "name": "Indices", + "namespace": "_types" } } }, { - "name": "scheduling", - "required": true, + "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.", + "name": "meta", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SchedulingConfiguration", - "namespace": "connector._types" + "name": "Metadata", + "namespace": "_types" } } }, { - "name": "service_type", + "description": "The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.", + "name": "non_aggregatable_indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Indices", + "namespace": "_types" } } }, { - "name": "status", - "required": true, + "description": "The list of indices where this field is not searchable, or null if all indices have the same definition for the field.", + "name": "non_searchable_indices", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ConnectorStatus", - "namespace": "connector._types" + "name": "Indices", + "namespace": "_types" } } }, { - "name": "sync_cursor", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "name": "sync_now", + "description": "Whether this field is indexed for search on all indices.", + "name": "searchable", "required": true, "type": { "kind": "instance_of", @@ -115690,77 +119207,45 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "connector/_types/Connector.ts#L252-L284" - }, - { - "kind": "interface", - "name": { - "name": "ConnectorFeatures", - "namespace": "connector._types" - }, - "properties": [ - { - "description": "Indicates whether document-level security is enabled.", - "name": "document_level_security", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FeatureEnabled", - "namespace": "connector._types" - } - } }, { - "description": "Indicates whether incremental syncs are enabled.", - "name": "incremental_sync", - "required": false, + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "FeatureEnabled", - "namespace": "connector._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Indicates whether managed connector API keys are enabled.", - "name": "native_connector_api_keys", + "description": "Whether this field is registered as a metadata field.", + "docId": "mapping-metadata", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html", + "name": "metadata_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FeatureEnabled", - "namespace": "connector._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "sync_rules", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SyncRulesFeature", - "namespace": "connector._types" + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "since": "8.0.0", + "stability": "experimental" } - } - } - ], - "specLocation": "connector/_types/Connector.ts#L230-L244" - }, - { - "kind": "interface", - "name": { - "name": "FeatureEnabled", - "namespace": "connector._types" - }, - "properties": [ - { - "name": "enabled", - "required": true, + }, + "description": "Whether this field is used as a time series dimension.", + "name": "time_series_dimension", + "required": false, "type": { "kind": "instance_of", "type": { @@ -115768,191 +119253,208 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "connector/_types/Connector.ts#L215-L217" - }, - { - "kind": "interface", - "name": { - "name": "SyncRulesFeature", - "namespace": "connector._types" - }, - "properties": [ - { - "description": "Indicates whether advanced sync rules are enabled.", - "name": "advanced", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FeatureEnabled", - "namespace": "connector._types" - } - } }, { - "description": "Indicates whether basic sync rules are enabled.", - "name": "basic", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FeatureEnabled", - "namespace": "connector._types" + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "since": "8.0.0", + "stability": "experimental" } - } - } - ], - "specLocation": "connector/_types/Connector.ts#L219-L228" - }, - { - "kind": "interface", - "name": { - "name": "FilteringConfig", - "namespace": "connector._types" - }, - "properties": [ - { - "name": "active", - "required": true, + }, + "description": "Contains metric type if this fields is used as a time series\nmetrics, absent if the field is not used as metric.", + "name": "time_series_metric", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "FilteringRules", - "namespace": "connector._types" + "name": "TimeSeriesMetricType", + "namespace": "_types.mapping" } } }, { - "name": "domain", + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "since": "8.0.0", + "stability": "experimental" + } + }, + "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.", + "name": "non_dimension_indices", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } } } }, { - "name": "draft", - "required": true, + "availability": { + "serverless": { + "stability": "experimental" + }, + "stack": { + "since": "8.0.0", + "stability": "experimental" + } + }, + "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.", + "name": "metric_conflicts_indices", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "FilteringRules", - "namespace": "connector._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } } } } ], - "specLocation": "connector/_types/Connector.ts#L209-L213" + "specLocation": "_global/field_caps/types.ts#L23-L81" }, { "kind": "interface", "name": { - "name": "FilteringRules", - "namespace": "connector._types" + "name": "StoredScript", + "namespace": "_types" }, "properties": [ { - "name": "advanced_snippet", + "description": "The language the script is written in.\nFor serach templates, use `mustache`.", + "name": "lang", "required": true, "type": { "kind": "instance_of", "type": { - "name": "FilteringAdvancedSnippet", - "namespace": "connector._types" + "name": "ScriptLanguage", + "namespace": "_types" } } }, { - "name": "rules", - "required": true, + "name": "options", + "required": false, "type": { - "kind": "array_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "FilteringRule", - "namespace": "connector._types" + "name": "string", + "namespace": "_builtins" } } } }, { - "name": "validation", + "description": "The script source.\nFor search templates, an object containing the search template.", + "name": "source", "required": true, "type": { "kind": "instance_of", "type": { - "name": "FilteringRulesValidation", - "namespace": "connector._types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "connector/_types/Connector.ts#L203-L207" + "specLocation": "_types/Scripting.ts#L47-L59" }, { "kind": "interface", "name": { - "name": "FilteringAdvancedSnippet", - "namespace": "connector._types" + "name": "Hop", + "namespace": "graph._types" }, "properties": [ { - "name": "created_at", + "description": "Specifies one or more fields from which you want to extract terms that are associated with the specified vertices.", + "name": "connections", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "Hop", + "namespace": "graph._types" } } }, { - "name": "updated_at", + "description": "An optional guiding query that constrains the Graph API as it explores connected terms.", + "name": "query", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "name": "value", + "description": "Contains the fields you are interested in.", + "name": "vertices", "required": true, "type": { - "kind": "user_defined_value" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "VertexDefinition", + "namespace": "graph._types" + } + } } } ], - "specLocation": "connector/_types/Connector.ts#L192-L196" + "specLocation": "graph/_types/Hop.ts#L23-L36" }, { "kind": "interface", "name": { - "name": "FilteringRule", - "namespace": "connector._types" + "name": "VertexDefinition", + "namespace": "graph._types" }, "properties": [ { - "name": "created_at", + "description": "Prevents the specified terms from being included in the results.", + "name": "exclude", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { + "description": "Identifies a field in the documents of interest.", "name": "field", "required": true, "type": { @@ -115964,62 +119466,82 @@ } }, { - "name": "id", - "required": true, + "description": "Identifies the terms of interest that form the starting points from which you want to spider out.", + "name": "include", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "VertexInclude", + "namespace": "graph._types" + } } } }, { - "name": "order", - "required": true, + "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.", + "name": "min_doc_count", + "required": false, + "serverDefault": 3, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "long", "namespace": "_types" } } }, { - "name": "policy", - "required": true, + "description": "Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration.", + "name": "shard_min_doc_count", + "required": false, + "serverDefault": 2, "type": { "kind": "instance_of", "type": { - "name": "FilteringPolicy", - "namespace": "connector._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "rule", - "required": true, + "description": "Specifies the maximum number of vertex terms returned for each field.", + "name": "size", + "required": false, + "serverDefault": 5, "type": { "kind": "instance_of", "type": { - "name": "FilteringRuleRule", - "namespace": "connector._types" + "name": "integer", + "namespace": "_types" } } - }, + } + ], + "specLocation": "graph/_types/Vertex.ts#L30-L59" + }, + { + "kind": "interface", + "name": { + "name": "VertexInclude", + "namespace": "graph._types" + }, + "properties": [ { - "name": "updated_at", + "name": "boost", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", + "name": "double", "namespace": "_types" } } }, { - "name": "value", + "name": "term", "required": true, "type": { "kind": "instance_of", @@ -116030,287 +119552,323 @@ } } ], - "specLocation": "connector/_types/Connector.ts#L170-L179" + "shortcutProperty": "term", + "specLocation": "graph/_types/Vertex.ts#L61-L65" }, { "kind": "interface", "name": { - "name": "FilteringRulesValidation", - "namespace": "connector._types" + "name": "ExploreControls", + "namespace": "graph._types" }, "properties": [ { - "name": "errors", - "required": true, + "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.", + "name": "sample_diversity", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FilteringValidation", - "namespace": "connector._types" - } + "kind": "instance_of", + "type": { + "name": "SampleDiversity", + "namespace": "graph._types" } } }, { - "name": "state", + "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.", + "name": "sample_size", + "required": false, + "serverDefault": 100, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Filters associated terms so only those that are significantly associated with your query are included.", + "docId": "search-aggregations-bucket-significantterms-aggregation", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html", + "name": "use_significance", "required": true, "type": { "kind": "instance_of", "type": { - "name": "FilteringValidationState", - "namespace": "connector._types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "connector/_types/Connector.ts#L198-L201" + "specLocation": "graph/_types/ExploreControls.ts#L24-L49" }, { "kind": "interface", "name": { - "name": "FilteringValidation", - "namespace": "connector._types" + "name": "SampleDiversity", + "namespace": "graph._types" }, "properties": [ { - "name": "ids", + "name": "field", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" } } }, { - "name": "messages", + "name": "max_docs_per_value", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "connector/_types/Connector.ts#L181-L184" + "specLocation": "graph/_types/ExploreControls.ts#L51-L54" }, { "kind": "interface", "name": { - "name": "IngestPipelineParams", - "namespace": "connector._types" + "name": "Connection", + "namespace": "graph._types" }, "properties": [ { - "name": "extract_binary_content", + "name": "doc_count", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "name", + "name": "source", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "reduce_whitespace", + "name": "target", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } }, { - "name": "run_ml_inference", + "name": "weight", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "double", + "namespace": "_types" } } } ], - "specLocation": "connector/_types/Connector.ts#L148-L153" + "specLocation": "graph/_types/Connection.ts#L22-L27" }, { "kind": "interface", "name": { - "name": "SchedulingConfiguration", - "namespace": "connector._types" + "name": "Vertex", + "namespace": "graph._types" }, "properties": [ { - "name": "access_control", - "required": false, + "name": "depth", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ConnectorScheduling", - "namespace": "connector._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "full", - "required": false, + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ConnectorScheduling", - "namespace": "connector._types" + "name": "Field", + "namespace": "_types" } } }, { - "name": "incremental", - "required": false, + "name": "term", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ConnectorScheduling", - "namespace": "connector._types" + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "weight", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "double", + "namespace": "_types" } } } ], - "specLocation": "connector/_types/Connector.ts#L246-L250" + "specLocation": "graph/_types/Vertex.ts#L23-L28" }, { "kind": "interface", "name": { - "name": "ConnectorScheduling", - "namespace": "connector._types" + "name": "IndicesBlockStatus", + "namespace": "indices.add_block" }, "properties": [ { - "name": "enabled", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } }, { - "description": "The interval is expressed using the crontab syntax", - "name": "interval", + "name": "blocked", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } } ], - "specLocation": "connector/_types/Connector.ts#L106-L110" + "specLocation": "indices/add_block/IndicesAddBlockResponse.ts#L30-L33" }, { "kind": "interface", "name": { - "name": "ConnectorSyncJob", - "namespace": "connector._types" + "name": "AnalyzeDetail", + "namespace": "indices.analyze" }, "properties": [ { - "name": "cancelation_requested_at", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } - }, - { - "name": "canceled_at", + "name": "analyzer", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", - "namespace": "_types" + "name": "AnalyzerDetail", + "namespace": "indices.analyze" } } }, { - "name": "completed_at", + "name": "charfilters", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CharFilterDetail", + "namespace": "indices.analyze" + } } } }, { - "name": "connector", + "name": "custom_analyzer", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SyncJobConnectorReference", - "namespace": "connector._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "created_at", - "required": true, + "name": "tokenfilters", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "TokenDetail", + "namespace": "indices.analyze" + } } } }, { - "name": "deleted_document_count", - "required": true, + "name": "tokenizer", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "TokenDetail", + "namespace": "indices.analyze" } } - }, + } + ], + "specLocation": "indices/analyze/types.ts#L24-L30" + }, + { + "kind": "interface", + "name": { + "name": "AnalyzerDetail", + "namespace": "indices.analyze" + }, + "properties": [ { - "name": "error", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { @@ -116320,29 +119878,69 @@ } }, { - "name": "id", + "name": "tokens", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ExplainAnalyzeToken", + "namespace": "indices.analyze" + } } } - }, + } + ], + "specLocation": "indices/analyze/types.ts#L32-L35" + }, + { + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ { - "name": "indexed_document_count", + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "user_defined_value" + } + ], + "meta": { + "description": "Additional tokenizer-specific attributes", + "fieldname": "attributes" + }, + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], + "kind": "interface", + "name": { + "name": "ExplainAnalyzeToken", + "namespace": "indices.analyze" + }, + "properties": [ + { + "name": "bytes", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "indexed_document_volume", + "name": "end_offset", "required": true, "type": { "kind": "instance_of", @@ -116353,69 +119951,51 @@ } }, { - "name": "job_type", - "required": true, + "name": "keyword", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "SyncJobType", - "namespace": "connector._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "last_seen", - "required": false, + "name": "position", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DateTime", + "name": "long", "namespace": "_types" } } }, { - "name": "metadata", + "name": "positionLength", "required": true, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "name": "started_at", - "required": false, "type": { "kind": "instance_of", "type": { - "name": "DateTime", + "name": "long", "namespace": "_types" } } }, { - "name": "status", + "name": "start_offset", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SyncStatus", - "namespace": "connector._types" + "name": "long", + "namespace": "_types" } } }, { - "name": "total_document_count", + "name": "termFrequency", "required": true, "type": { "kind": "instance_of", @@ -116426,19 +120006,19 @@ } }, { - "name": "trigger_method", + "name": "token", "required": true, "type": { "kind": "instance_of", "type": { - "name": "SyncJobTriggerMethod", - "namespace": "connector._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "worker_hostname", - "required": false, + "name": "type", + "required": true, "type": { "kind": "instance_of", "type": { @@ -116448,50 +120028,31 @@ } } ], - "specLocation": "connector/_types/SyncJob.ts#L53-L72" + "specLocation": "indices/analyze/types.ts#L52-L67" }, { "kind": "interface", "name": { - "name": "SyncJobConnectorReference", - "namespace": "connector._types" + "name": "CharFilterDetail", + "namespace": "indices.analyze" }, "properties": [ { - "name": "configuration", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ConnectorConfiguration", - "namespace": "connector._types" - } - } - }, - { - "name": "filtering", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "FilteringRules", - "namespace": "connector._types" - } - } - }, - { - "name": "id", + "name": "filtered_text", "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "index_name", + "name": "name", "required": true, "type": { "kind": "instance_of", @@ -116500,31 +120061,19 @@ "namespace": "_builtins" } } - }, - { - "name": "language", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "pipeline", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IngestPipelineParams", - "namespace": "connector._types" - } - } - }, + } + ], + "specLocation": "indices/analyze/types.ts#L46-L49" + }, + { + "kind": "interface", + "name": { + "name": "TokenDetail", + "namespace": "indices.analyze" + }, + "properties": [ { - "name": "service_type", + "name": "name", "required": true, "type": { "kind": "instance_of", @@ -116535,49 +120084,53 @@ } }, { - "name": "sync_cursor", - "required": false, + "name": "tokens", + "required": true, "type": { - "kind": "user_defined_value" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ExplainAnalyzeToken", + "namespace": "indices.analyze" + } + } } } ], - "specLocation": "connector/_types/SyncJob.ts#L31-L40" + "specLocation": "indices/analyze/types.ts#L71-L74" }, { "kind": "interface", "name": { - "name": "WriteResponseBase", - "namespace": "_types" + "name": "AnalyzeToken", + "namespace": "indices.analyze" }, "properties": [ { - "description": "The unique identifier for the added document.", - "name": "_id", + "name": "end_offset", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "long", "namespace": "_types" } } }, { - "description": "The name of the index the document was added to.", - "name": "_index", + "name": "position", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "long", "namespace": "_types" } } }, { - "description": "The primary term assigned to the document for the indexing operation.", - "name": "_primary_term", + "name": "positionLength", "required": false, "type": { "kind": "instance_of", @@ -116588,325 +120141,320 @@ } }, { - "description": "The result of the indexing operation: `created` or `updated`.", - "name": "result", + "name": "start_offset", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Result", - "namespace": "_types" - } - } - }, - { - "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.", - "name": "_seq_no", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SequenceNumber", + "name": "long", "namespace": "_types" } } }, { - "description": "Information about the replication process of the operation.", - "name": "_shards", + "name": "token", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The document version, which is incremented each time the document is updated.", - "name": "_version", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "indices/analyze/types.ts#L37-L44" + }, + { + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, + "kind": "interface", + "name": { + "name": "IndicesResponseBase", + "namespace": "_types" + }, + "properties": [ { - "name": "forced_refresh", + "name": "_shards", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ShardStatistics", + "namespace": "_types" } } } ], - "specLocation": "_types/Base.ts#L36-L67" + "specLocation": "_types/Base.ts#L138-L140" }, { "kind": "interface", "name": { - "name": "BulkIndexByScrollFailure", - "namespace": "_types" + "name": "DataStreamLifecycleExplain", + "namespace": "indices.explain_data_lifecycle" }, "properties": [ { - "name": "cause", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ErrorCause", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "id", + "name": "managed_by_lifecycle", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "index_creation_date_millis", + "required": false, + "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], + "kind": "instance_of", + "type": { + "name": "EpochTime", "namespace": "_types" } } }, { - "name": "index", - "required": true, + "name": "time_since_index_creation", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Duration", "namespace": "_types" } } }, { - "name": "status", - "required": true, + "name": "rollover_date_millis", + "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "integer", + "name": "EpochTime", "namespace": "_types" } } - } - ], - "specLocation": "_types/Errors.ts#L60-L65" - }, - { - "kind": "interface", - "name": { - "name": "Retries", - "namespace": "_types" - }, - "properties": [ + }, { - "description": "The number of bulk actions retried.", - "name": "bulk", - "required": true, + "name": "time_since_rollover", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Duration", "namespace": "_types" } } }, { - "description": "The number of search actions retried.", - "name": "search", - "required": true, + "name": "lifecycle", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "DataStreamLifecycleWithRollover", + "namespace": "indices._types" + } + } + }, + { + "name": "generation_time", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", "namespace": "_types" } } - } - ], - "specLocation": "_types/Retries.ts#L22-L31" - }, - { - "kind": "interface", - "name": { - "name": "ExecuteEnrichPolicyStatus", - "namespace": "enrich.execute_policy" - }, - "properties": [ + }, { - "name": "phase", - "required": true, + "name": "error", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "EnrichPolicyPhase", - "namespace": "enrich.execute_policy" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "enrich/execute_policy/types.ts#L20-L22" + "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponse.ts#L31-L41" }, { "kind": "interface", "name": { - "name": "Summary", - "namespace": "enrich._types" + "name": "IndexAliases", + "namespace": "indices.get_alias" }, "properties": [ { - "name": "config", + "name": "aliases", "required": true, "type": { "key": { "kind": "instance_of", "type": { - "name": "PolicyType", - "namespace": "enrich._types" + "name": "string", + "namespace": "_builtins" } }, "kind": "dictionary_of", - "singleKey": true, + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "Policy", - "namespace": "enrich._types" + "name": "AliasDefinition", + "namespace": "indices._types" } } } } ], - "specLocation": "enrich/_types/Policy.ts#L24-L26" + "specLocation": "indices/get_alias/IndicesGetAliasResponse.ts#L37-L39" }, { "kind": "interface", "name": { - "name": "Policy", - "namespace": "enrich._types" + "name": "DataStreamWithLifecycle", + "namespace": "indices.get_data_lifecycle" }, "properties": [ { - "name": "enrich_fields", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Fields", - "namespace": "_types" - } - } - }, - { - "name": "indices", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } - }, - { - "name": "match_field", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "DataStreamName", "namespace": "_types" } } }, { - "name": "query", + "name": "lifecycle", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "DataStreamLifecycleWithRollover", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleResponse.ts#L27-L30" + }, + { + "kind": "interface", + "name": { + "name": "DataStream", + "namespace": "indices._types" + }, + "properties": [ { - "name": "name", + "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.", + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Metadata", "namespace": "_types" } } }, { - "name": "elasticsearch_version", + "description": "If `true`, the data stream allows custom routing on write request.", + "name": "allow_custom_routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } - } - ], - "specLocation": "enrich/_types/Policy.ts#L34-L41" - }, - { - "generics": [ - { - "name": "TEvent", - "namespace": "eql._types.EqlSearchResponseBase" - } - ], - "kind": "interface", - "name": { - "name": "EqlSearchResponseBase", - "namespace": "eql._types" - }, - "properties": [ + }, { - "description": "Identifier for the search.", - "name": "id", + "description": "Information about failure store backing indices", + "name": "failure_store", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "FailureStore", + "namespace": "indices._types" } } }, { - "description": "If true, the response does not contain complete search results.", - "name": "is_partial", - "required": false, + "description": "Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.", + "name": "generation", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "description": "If true, the search request is still executing.", - "name": "is_running", - "required": false, + "description": "If `true`, the data stream is hidden.", + "name": "hidden", + "required": true, "type": { "kind": "instance_of", "type": { @@ -116916,209 +120464,134 @@ } }, { - "description": "Milliseconds it took Elasticsearch to execute the request.", - "name": "took", + "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.", + "name": "ilm_policy", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "Name", "namespace": "_types" } } }, { - "description": "If true, the request timed out before completion.", - "name": "timed_out", - "required": false, + "description": "Name of the lifecycle system that'll manage the next generation of the data stream.", + "name": "next_generation_managed_by", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ManagedBy", + "namespace": "indices._types" } } }, { - "description": "Contains matching events and sequences. Also contains related metadata.", - "name": "hits", + "description": "Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.", + "name": "prefer_ilm", "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TEvent", - "namespace": "eql._types.EqlSearchResponseBase" - } - } - ], "kind": "instance_of", "type": { - "name": "EqlHits", - "namespace": "eql._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains information about shard failures (if any), in case allow_partial_search_results=true", - "name": "shard_failures", - "required": false, + "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.", + "name": "indices", + "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "ShardFailure", - "namespace": "_types" + "name": "DataStreamIndex", + "namespace": "indices._types" } } } - } - ], - "specLocation": "eql/_types/EqlSearchResponseBase.ts#L25-L54" - }, - { - "generics": [ - { - "name": "TEvent", - "namespace": "eql._types.EqlHits" - } - ], - "kind": "interface", - "name": { - "name": "EqlHits", - "namespace": "eql._types" - }, - "properties": [ + }, { - "description": "Metadata about the number of matching events or sequences.", - "name": "total", + "availability": { + "serverless": { + "stability": "stable" + }, + "stack": { + "since": "8.11.0", + "stability": "stable" + } + }, + "description": "Contains the configuration for the data stream lifecycle of this data stream.", + "name": "lifecycle", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TotalHits", - "namespace": "_global.search._types" + "name": "DataStreamLifecycleWithRollover", + "namespace": "indices._types" } } }, { - "description": "Contains events matching the query. Each object represents a matching event.", - "name": "events", - "required": false, + "description": "Name of the data stream.", + "name": "name", + "required": true, "type": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TEvent", - "namespace": "eql._types.EqlHits" - } - } - ], - "kind": "instance_of", - "type": { - "name": "HitsEvent", - "namespace": "eql._types" - } + "kind": "instance_of", + "type": { + "name": "DataStreamName", + "namespace": "_types" } } }, { - "description": "Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.", - "docId": "eql-sequences", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", - "name": "sequences", + "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.", + "name": "replicated", "required": false, - "type": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TEvent", - "namespace": "eql._types.EqlHits" - } - } - ], - "kind": "instance_of", - "type": { - "name": "HitsSequence", - "namespace": "eql._types" - } - } - } - } - ], - "specLocation": "eql/_types/EqlHits.ts#L25-L39" - }, - { - "generics": [ - { - "name": "TEvent", - "namespace": "eql._types.HitsEvent" - } - ], - "kind": "interface", - "name": { - "name": "HitsEvent", - "namespace": "eql._types" - }, - "properties": [ - { - "description": "Name of the index containing the event.", - "name": "_index", - "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Unique identifier for the event. This ID is only unique within the index.", - "name": "_id", + "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.", + "name": "rollover_on_write", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Original JSON body passed for the event at index time.", - "name": "_source", + "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.", + "name": "status", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TEvent", - "namespace": "eql._types.HitsEvent" + "name": "HealthStatus", + "namespace": "_types" } } }, { - "description": "Set to `true` for events in a timespan-constrained sequence that do not meet a given condition.", - "docId": "eql-missing-events", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-missing-events", - "name": "missing", + "availability": { + "serverless": {}, + "stack": { + "since": "7.10.0" + } + }, + "description": "If `true`, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.", + "name": "system", "required": false, "type": { "kind": "instance_of", @@ -117129,222 +120602,137 @@ } }, { - "name": "fields", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "kind": "user_defined_value" - } - } - } - } - ], - "specLocation": "eql/_types/EqlHits.ts#L41-L54" - }, - { - "generics": [ - { - "name": "TEvent", - "namespace": "eql._types.HitsSequence" - } - ], - "kind": "interface", - "name": { - "name": "HitsSequence", - "namespace": "eql._types" - }, - "properties": [ - { - "description": "Contains events matching the query. Each object represents a matching event.", - "name": "events", + "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.", + "name": "template", "required": true, "type": { - "kind": "array_of", - "value": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "TEvent", - "namespace": "eql._types.HitsSequence" - } - } - ], - "kind": "instance_of", - "type": { - "name": "HitsEvent", - "namespace": "eql._types" - } + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } }, { - "description": "Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.", - "docId": "eql-sequences", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", - "name": "join_keys", - "required": false, + "description": "Information about the `@timestamp` field in the data stream.", + "name": "timestamp_field", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "DataStreamTimestampField", + "namespace": "indices._types" } } } ], - "specLocation": "eql/_types/EqlHits.ts#L56-L64" + "specLocation": "indices/_types/DataStream.ts#L45-L127" }, { "kind": "interface", "name": { - "name": "TableValuesContainer", - "namespace": "esql._types" + "name": "FailureStore", + "namespace": "indices._types" }, "properties": [ { - "name": "integer", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TableValuesIntegerValue", - "namespace": "esql._types" - } - } - } - }, - { - "name": "keyword", - "required": false, + "name": "enabled", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TableValuesKeywordValue", - "namespace": "esql._types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "long", - "required": false, + "name": "indices", + "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "TableValuesLongValue", - "namespace": "esql._types" + "name": "DataStreamIndex", + "namespace": "indices._types" } } } }, { - "name": "double", - "required": false, + "name": "rollover_on_write", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TableValuesLongDouble", - "namespace": "esql._types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "esql/_types/TableValuesContainer.ts#L22-L28", - "variants": { - "kind": "container" - } + "specLocation": "indices/_types/DataStream.ts#L39-L43" }, { "kind": "interface", "name": { - "name": "FieldCapability", - "namespace": "_global.field_caps" + "name": "DataStreamIndex", + "namespace": "indices._types" }, "properties": [ { - "description": "Whether this field can be aggregated on all indices.", - "name": "aggregatable", + "description": "Name of the backing index.", + "name": "index_name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "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.", - "name": "indices", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", + "name": "IndexName", "namespace": "_types" } } }, { - "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.", - "name": "meta", - "required": false, + "description": "Universally unique identifier (UUID) for the index.", + "name": "index_uuid", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Metadata", + "name": "Uuid", "namespace": "_types" } } }, { - "description": "The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.", - "name": "non_aggregatable_indices", + "description": "Name of the current ILM lifecycle policy configured for this backing index.", + "name": "ilm_policy", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "Name", "namespace": "_types" } } }, { - "description": "The list of indices where this field is not searchable, or null if all indices have the same definition for the field.", - "name": "non_searchable_indices", + "description": "Name of the lifecycle system that's currently managing this backing index.", + "name": "managed_by", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "ManagedBy", + "namespace": "indices._types" } } }, { - "description": "Whether this field is indexed for search on all indices.", - "name": "searchable", - "required": true, + "description": "Indicates if ILM should take precedence over DSL in case both are configured to manage this index.", + "name": "prefer_ilm", + "required": false, "type": { "kind": "instance_of", "type": { @@ -117352,663 +120740,621 @@ "namespace": "_builtins" } } - }, + } + ], + "specLocation": "indices/_types/DataStream.ts#L136-L157" + }, + { + "kind": "interface", + "name": { + "name": "DataStreamTimestampField", + "namespace": "indices._types" + }, + "properties": [ { - "name": "type", + "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.", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/_types/DataStream.ts#L129-L134" + }, + { + "kind": "interface", + "name": { + "name": "IndexTemplateItem", + "namespace": "indices.get_index_template" + }, + "properties": [ { - "description": "Whether this field is registered as a metadata field.", - "docId": "mapping-metadata", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html", - "name": "metadata_field", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "since": "8.0.0", - "stability": "experimental" - } - }, - "description": "Whether this field is used as a time series dimension.", - "name": "time_series_dimension", - "required": false, + "name": "index_template", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IndexTemplate", + "namespace": "indices._types" } } - }, + } + ], + "specLocation": "indices/get_index_template/IndicesGetIndexTemplateResponse.ts#L29-L32" + }, + { + "kind": "interface", + "name": { + "name": "IndexTemplate", + "namespace": "indices._types" + }, + "properties": [ { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "since": "8.0.0", - "stability": "experimental" - } - }, - "description": "Contains metric type if this fields is used as a time series\nmetrics, absent if the field is not used as metric.", - "name": "time_series_metric", - "required": false, + "description": "Name of the index template.", + "name": "index_patterns", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TimeSeriesMetricType", - "namespace": "_types.mapping" + "name": "Names", + "namespace": "_types" } } }, { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "since": "8.0.0", - "stability": "experimental" - } - }, - "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.", - "name": "non_dimension_indices", - "required": false, + "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.", + "name": "composed_of", + "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Name", "namespace": "_types" } } } }, { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "since": "8.0.0", - "stability": "experimental" + "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", + "name": "template", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexTemplateSummary", + "namespace": "indices._types" } - }, - "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.", - "name": "metric_conflicts_indices", + } + }, + { + "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.", + "name": "version", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" } } - } - ], - "specLocation": "_global/field_caps/types.ts#L23-L81" - }, - { - "kind": "interface", - "name": { - "name": "StoredScript", - "namespace": "_types" - }, - "properties": [ + }, { - "description": "The language the script is written in.\nFor serach templates, use `mustache`.", - "name": "lang", - "required": true, + "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.", + "name": "priority", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ScriptLanguage", + "name": "long", "namespace": "_types" } } }, { - "name": "options", + "description": "Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch.", + "docId": "mapping-meta-field", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "name": "_meta", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "Metadata", + "namespace": "_types" } } }, { - "description": "The script source.\nFor search templates, an object containing the search template.", - "name": "source", - "required": true, + "name": "allow_auto_create", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } - } - ], - "specLocation": "_types/Scripting.ts#L47-L59" - }, - { - "kind": "interface", - "name": { - "name": "Hop", - "namespace": "graph._types" - }, - "properties": [ + }, { - "description": "Specifies one or more fields from which you want to extract terms that are associated with the specified vertices.", - "name": "connections", + "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.", + "name": "data_stream", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Hop", - "namespace": "graph._types" + "name": "IndexTemplateDataStreamConfiguration", + "namespace": "indices._types" } } }, { - "description": "An optional guiding query that constrains the Graph API as it explores connected terms.", - "name": "query", + "availability": { + "serverless": {}, + "stack": { + "since": "8.12.0" + } + }, + "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.", + "name": "deprecated", "required": false, "type": { "kind": "instance_of", "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Contains the fields you are interested in.", - "name": "vertices", - "required": true, + "availability": { + "serverless": {}, + "stack": { + "since": "8.7.0" + } + }, + "description": "A list of component template names that are allowed to be absent.", + "name": "ignore_missing_component_templates", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "VertexDefinition", - "namespace": "graph._types" - } + "kind": "instance_of", + "type": { + "name": "Names", + "namespace": "_types" } } } ], - "specLocation": "graph/_types/Hop.ts#L23-L36" + "specLocation": "indices/_types/IndexTemplate.ts#L28-L81" }, { "kind": "interface", "name": { - "name": "VertexDefinition", - "namespace": "graph._types" + "name": "IndexTemplateSummary", + "namespace": "indices._types" }, "properties": [ { - "description": "Prevents the specified terms from being included in the results.", - "name": "exclude", + "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.", + "name": "aliases", "required": false, "type": { - "kind": "array_of", - "value": { + "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } - } - } - }, - { - "description": "Identifies a field in the documents of interest.", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "Identifies the terms of interest that form the starting points from which you want to spider out.", - "name": "include", - "required": false, - "type": { - "kind": "array_of", + }, + "kind": "dictionary_of", + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "VertexInclude", - "namespace": "graph._types" + "name": "Alias", + "namespace": "indices._types" } } } }, { - "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.", - "name": "min_doc_count", + "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.", + "name": "mappings", "required": false, - "serverDefault": 3, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "description": "Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration.", - "name": "shard_min_doc_count", + "description": "Configuration options for the index.", + "name": "settings", "required": false, - "serverDefault": 2, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "IndexSettings", + "namespace": "indices._types" } } }, { - "description": "Specifies the maximum number of vertex terms returned for each field.", - "name": "size", + "availability": { + "serverless": { + "stability": "stable" + }, + "stack": { + "since": "8.11.0", + "stability": "stable" + } + }, + "name": "lifecycle", "required": false, - "serverDefault": 5, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "DataStreamLifecycleWithRollover", + "namespace": "indices._types" } } } ], - "specLocation": "graph/_types/Vertex.ts#L30-L59" + "specLocation": "indices/_types/IndexTemplate.ts#L96-L118" }, { "kind": "interface", "name": { - "name": "VertexInclude", - "namespace": "graph._types" + "name": "IndexTemplateDataStreamConfiguration", + "namespace": "indices._types" }, "properties": [ { - "name": "boost", + "description": "If true, the data stream is hidden.", + "name": "hidden", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "term", - "required": true, + "description": "If true, the data stream supports custom routing.", + "name": "allow_custom_routing", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } } ], - "shortcutProperty": "term", - "specLocation": "graph/_types/Vertex.ts#L61-L65" + "specLocation": "indices/_types/IndexTemplate.ts#L83-L94" }, { "kind": "interface", "name": { - "name": "ExploreControls", - "namespace": "graph._types" + "name": "IndexMappingRecord", + "namespace": "indices.get_mapping" }, "properties": [ { - "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.", - "name": "sample_diversity", + "name": "item", "required": false, "type": { "kind": "instance_of", "type": { - "name": "SampleDiversity", - "namespace": "graph._types" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "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.", - "name": "sample_size", - "required": false, - "serverDefault": 100, + "name": "mappings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "TypeMapping", + "namespace": "_types.mapping" } } - }, + } + ], + "specLocation": "indices/get_mapping/IndicesGetMappingResponse.ts#L29-L32" + }, + { + "kind": "interface", + "name": { + "name": "Action", + "namespace": "indices.modify_data_stream" + }, + "properties": [ { - "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.", - "name": "timeout", + "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.", + "name": "add_backing_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "IndexAndDataStreamAction", + "namespace": "indices.modify_data_stream" } } }, { - "description": "Filters associated terms so only those that are significantly associated with your query are included.", - "docId": "search-aggregations-bucket-significantterms-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html", - "name": "use_significance", - "required": true, + "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.", + "name": "remove_backing_index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IndexAndDataStreamAction", + "namespace": "indices.modify_data_stream" } } } ], - "specLocation": "graph/_types/ExploreControls.ts#L24-L49" + "specLocation": "indices/modify_data_stream/types.ts#L22-L37", + "variants": { + "kind": "container" + } }, { "kind": "interface", "name": { - "name": "SampleDiversity", - "namespace": "graph._types" + "name": "IndexAndDataStreamAction", + "namespace": "indices.modify_data_stream" }, "properties": [ { - "name": "field", + "description": "Data stream targeted by the action.", + "name": "data_stream", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "DataStreamName", "namespace": "_types" } } }, { - "name": "max_docs_per_value", + "description": "Index for the action.", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "IndexName", "namespace": "_types" } } } ], - "specLocation": "graph/_types/ExploreControls.ts#L51-L54" + "specLocation": "indices/modify_data_stream/types.ts#L39-L44" }, { "kind": "interface", "name": { - "name": "Connection", - "namespace": "graph._types" + "name": "IndexTemplateMapping", + "namespace": "indices.put_index_template" }, "properties": [ { - "name": "doc_count", - "required": true, + "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.", + "name": "aliases", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" + "key": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "Alias", + "namespace": "indices._types" + } } } }, { - "name": "source", - "required": true, + "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.", + "name": "mappings", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "name": "target", - "required": true, + "description": "Configuration options for the index.", + "name": "settings", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "IndexSettings", + "namespace": "indices._types" } } }, { - "name": "weight", - "required": true, + "availability": { + "serverless": { + "stability": "stable" + }, + "stack": { + "since": "8.11.0", + "stability": "stable" + } + }, + "name": "lifecycle", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "DataStreamLifecycle", + "namespace": "indices._types" } } } ], - "specLocation": "graph/_types/Connection.ts#L22-L27" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L159-L181" }, { "kind": "interface", "name": { - "name": "Vertex", - "namespace": "graph._types" + "name": "DataStreamVisibility", + "namespace": "indices._types" }, "properties": [ { - "name": "depth", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "term", - "required": true, + "name": "hidden", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "name": "weight", - "required": true, + "name": "allow_custom_routing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "double", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "graph/_types/Vertex.ts#L23-L28" + "specLocation": "indices/_types/DataStream.ts#L159-L162" }, { "kind": "interface", "name": { - "name": "IndicesBlockStatus", - "namespace": "indices.add_block" + "name": "ShardsOperationResponseBase", + "namespace": "_types" }, "properties": [ { - "name": "name", - "required": true, + "name": "_shards", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "ShardStatistics", "namespace": "_types" } } - }, - { - "name": "blocked", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } } ], - "specLocation": "indices/add_block/IndicesAddBlockResponse.ts#L30-L33" + "specLocation": "_types/Base.ts#L142-L145" }, { "kind": "interface", "name": { - "name": "AnalyzeDetail", - "namespace": "indices.analyze" + "name": "ResolveIndexItem", + "namespace": "indices.resolve_index" }, "properties": [ { - "name": "analyzer", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "AnalyzerDetail", - "namespace": "indices.analyze" + "name": "Name", + "namespace": "_types" } } }, { - "name": "charfilters", + "name": "aliases", "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "CharFilterDetail", - "namespace": "indices.analyze" + "name": "string", + "namespace": "_builtins" } } } }, { - "name": "custom_analyzer", + "name": "attributes", "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "tokenfilters", - "required": false, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "TokenDetail", - "namespace": "indices.analyze" + "name": "string", + "namespace": "_builtins" } } } }, { - "name": "tokenizer", + "name": "data_stream", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TokenDetail", - "namespace": "indices.analyze" + "name": "DataStreamName", + "namespace": "_types" } } } ], - "specLocation": "indices/analyze/types.ts#L24-L30" + "specLocation": "indices/resolve_index/ResolveIndexResponse.ts#L30-L35" }, { "kind": "interface", "name": { - "name": "AnalyzerDetail", - "namespace": "indices.analyze" + "name": "ResolveIndexAliasItem", + "namespace": "indices.resolve_index" }, "properties": [ { @@ -118017,265 +121363,119 @@ "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } }, { - "name": "tokens", + "name": "indices", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ExplainAnalyzeToken", - "namespace": "indices.analyze" - } + "kind": "instance_of", + "type": { + "name": "Indices", + "namespace": "_types" } } } ], - "specLocation": "indices/analyze/types.ts#L32-L35" + "specLocation": "indices/resolve_index/ResolveIndexResponse.ts#L37-L40" }, { - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "user_defined_value" - } - ], - "meta": { - "description": "Additional tokenizer-specific attributes", - "fieldname": "attributes" - }, - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } - } - ], "kind": "interface", "name": { - "name": "ExplainAnalyzeToken", - "namespace": "indices.analyze" + "name": "ResolveIndexDataStreamsItem", + "namespace": "indices.resolve_index" }, "properties": [ { - "name": "bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "end_offset", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "keyword", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "position", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "positionLength", + "name": "name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "DataStreamName", "namespace": "_types" } } }, { - "name": "start_offset", + "name": "timestamp_field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Field", "namespace": "_types" } } }, { - "name": "termFrequency", + "name": "backing_indices", "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Indices", "namespace": "_types" } } - }, - { - "name": "token", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "indices/analyze/types.ts#L52-L67" - }, - { - "kind": "interface", - "name": { - "name": "CharFilterDetail", - "namespace": "indices.analyze" - }, - "properties": [ - { - "name": "filtered_text", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } } ], - "specLocation": "indices/analyze/types.ts#L46-L49" + "specLocation": "indices/resolve_index/ResolveIndexResponse.ts#L42-L46" }, { "kind": "interface", "name": { - "name": "TokenDetail", - "namespace": "indices.analyze" + "name": "RolloverConditions", + "namespace": "indices.rollover" }, "properties": [ { - "name": "name", - "required": true, + "name": "min_age", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "name": "tokens", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ExplainAnalyzeToken", - "namespace": "indices.analyze" - } - } - } - } - ], - "specLocation": "indices/analyze/types.ts#L71-L74" - }, - { - "kind": "interface", - "name": { - "name": "AnalyzeToken", - "namespace": "indices.analyze" - }, - "properties": [ - { - "name": "end_offset", - "required": true, + "name": "max_age", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", + "name": "Duration", "namespace": "_types" } } }, { - "name": "position", - "required": true, + "name": "max_age_millis", + "required": false, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "long", + "name": "DurationValue", "namespace": "_types" } } }, { - "name": "positionLength", + "name": "min_docs", "required": false, "type": { "kind": "instance_of", @@ -118286,8 +121486,8 @@ } }, { - "name": "start_offset", - "required": true, + "name": "max_docs", + "required": false, "type": { "kind": "instance_of", "type": { @@ -118297,189 +121497,158 @@ } }, { - "name": "token", - "required": true, + "name": "max_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { - "name": "type", - "required": true, + "name": "max_size_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "long", + "namespace": "_types" } } - } - ], - "specLocation": "indices/analyze/types.ts#L37-L44" - }, - { - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, - "kind": "interface", - "name": { - "name": "IndicesResponseBase", - "namespace": "_types" - }, - "properties": [ + }, { - "name": "_shards", + "name": "min_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", + "name": "ByteSize", "namespace": "_types" } } - } - ], - "specLocation": "_types/Base.ts#L138-L140" - }, - { - "kind": "interface", - "name": { - "name": "DataStreamLifecycleExplain", - "namespace": "indices.explain_data_lifecycle" - }, - "properties": [ + }, { - "name": "index", - "required": true, + "name": "min_size_bytes", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "long", "namespace": "_types" } } }, { - "name": "managed_by_lifecycle", - "required": true, + "name": "max_primary_shard_size", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "ByteSize", + "namespace": "_types" } } }, { - "name": "index_creation_date_millis", + "name": "max_primary_shard_size_bytes", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "EpochTime", + "name": "long", "namespace": "_types" } } }, { - "name": "time_since_index_creation", + "name": "min_primary_shard_size", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "ByteSize", "namespace": "_types" } } }, { - "name": "rollover_date_millis", + "name": "min_primary_shard_size_bytes", "required": false, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "EpochTime", + "name": "long", "namespace": "_types" } } }, { - "name": "time_since_rollover", + "name": "max_primary_shard_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "long", "namespace": "_types" } } }, { - "name": "lifecycle", + "name": "min_primary_shard_docs", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamLifecycleWithRollover", - "namespace": "indices._types" + "name": "long", + "namespace": "_types" } } - }, + } + ], + "specLocation": "indices/rollover/types.ts#L24-L40" + }, + { + "kind": "interface", + "name": { + "name": "Overlapping", + "namespace": "indices.simulate_template" + }, + "properties": [ { - "name": "generation_time", - "required": false, + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "Name", "namespace": "_types" } } }, { - "name": "error", - "required": false, + "name": "index_patterns", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } ], - "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponse.ts#L31-L41" + "specLocation": "indices/simulate_template/IndicesSimulateTemplateResponse.ts#L39-L42" }, { "kind": "interface", "name": { - "name": "IndexAliases", - "namespace": "indices.get_alias" + "name": "Template", + "namespace": "indices.simulate_template" }, "properties": [ { @@ -118489,8 +121658,8 @@ "key": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } }, "kind": "dictionary_of", @@ -118498,204 +121667,185 @@ "value": { "kind": "instance_of", "type": { - "name": "AliasDefinition", + "name": "Alias", "namespace": "indices._types" } } } - } - ], - "specLocation": "indices/get_alias/IndicesGetAliasResponse.ts#L37-L39" - }, - { - "kind": "interface", - "name": { - "name": "DataStreamWithLifecycle", - "namespace": "indices.get_data_lifecycle" - }, - "properties": [ + }, { - "name": "name", + "name": "mappings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataStreamName", - "namespace": "_types" + "name": "TypeMapping", + "namespace": "_types.mapping" } } }, { - "name": "lifecycle", - "required": false, + "name": "settings", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataStreamLifecycleWithRollover", + "name": "IndexSettings", "namespace": "indices._types" } } } ], - "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleResponse.ts#L27-L30" + "specLocation": "indices/simulate_template/IndicesSimulateTemplateResponse.ts#L33-L37" }, { "kind": "interface", "name": { - "name": "DataStream", - "namespace": "indices._types" + "name": "Action", + "namespace": "indices.update_aliases" }, "properties": [ { - "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.", - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "_meta", + "description": "Adds a data stream or index to an alias.\nIf the alias doesn’t exist, the `add` action creates it.", + "name": "add", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Metadata", - "namespace": "_types" + "name": "AddAction", + "namespace": "indices.update_aliases" } } }, { - "description": "If `true`, the data stream allows custom routing on write request.", - "name": "allow_custom_routing", + "description": "Removes a data stream or index from an alias.", + "name": "remove", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "RemoveAction", + "namespace": "indices.update_aliases" } } }, { - "description": "Information about failure store backing indices", - "name": "failure_store", + "description": "Deletes an index.\nYou cannot use this action on aliases or data streams.", + "name": "remove_index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FailureStore", - "namespace": "indices._types" + "name": "RemoveIndexAction", + "namespace": "indices.update_aliases" } } - }, + } + ], + "specLocation": "indices/update_aliases/types.ts#L23-L39", + "variants": { + "kind": "container" + } + }, + { + "kind": "interface", + "name": { + "name": "AddAction", + "namespace": "indices.update_aliases" + }, + "properties": [ { - "description": "Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.", - "name": "generation", - "required": true, + "description": "Alias for the action.\nIndex alias names support date math.", + "name": "alias", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "IndexAlias", "namespace": "_types" } } }, { - "description": "If `true`, the data stream is hidden.", - "name": "hidden", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "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.", - "name": "ilm_policy", + "description": "Aliases for the action.\nIndex alias names support date math.", + "name": "aliases", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } + "items": [ + { + "kind": "instance_of", + "type": { + "name": "IndexAlias", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndexAlias", + "namespace": "_types" + } + } + } + ], + "kind": "union_of" } }, { - "description": "Name of the lifecycle system that'll manage the next generation of the data stream.", - "name": "next_generation_managed_by", - "required": true, + "description": "Query used to limit documents the alias can access.", + "name": "filter", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "ManagedBy", - "namespace": "indices._types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "description": "Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.", - "name": "prefer_ilm", - "required": true, + "description": "Data stream or index for the action.\nSupports wildcards (`*`).", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } }, { - "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.", + "description": "Data streams or indices for the action.\nSupports wildcards (`*`).", "name": "indices", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataStreamIndex", - "namespace": "indices._types" - } - } - } - }, - { - "availability": { - "serverless": { - "stability": "stable" - }, - "stack": { - "since": "8.11.0", - "stability": "stable" - } - }, - "description": "Contains the configuration for the data stream lifecycle of this data stream.", - "name": "lifecycle", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamLifecycleWithRollover", - "namespace": "indices._types" + "name": "Indices", + "namespace": "_types" } } }, { - "description": "Name of the data stream.", - "name": "name", - "required": true, + "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.", + "name": "index_routing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamName", + "name": "Routing", "namespace": "_types" } } }, { - "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.", - "name": "replicated", + "description": "If `true`, the alias is hidden.", + "name": "is_hidden", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -118705,9 +121855,9 @@ } }, { - "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.", - "name": "rollover_on_write", - "required": true, + "description": "If `true`, sets the write index or data stream for the alias.", + "name": "is_write_index", + "required": false, "type": { "kind": "instance_of", "type": { @@ -118717,167 +121867,167 @@ } }, { - "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.", - "name": "status", - "required": true, + "description": "Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.", + "name": "routing", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "HealthStatus", + "name": "Routing", "namespace": "_types" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.10.0" - } - }, - "description": "If `true`, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.", - "name": "system", + "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.", + "name": "search_routing", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "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.", - "name": "template", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", + "name": "Routing", "namespace": "_types" } } }, { - "description": "Information about the `@timestamp` field in the data stream.", - "name": "timestamp_field", - "required": true, + "description": "If `true`, the alias must exist to perform the action.", + "name": "must_exist", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamTimestampField", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "indices/_types/DataStream.ts#L45-L127" + "specLocation": "indices/update_aliases/types.ts#L41-L95" }, { "kind": "interface", "name": { - "name": "FailureStore", - "namespace": "indices._types" + "name": "RemoveAction", + "namespace": "indices.update_aliases" }, "properties": [ { - "name": "enabled", - "required": true, + "description": "Alias for the action.\nIndex alias names support date math.", + "name": "alias", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IndexAlias", + "namespace": "_types" } } }, { - "name": "indices", - "required": true, + "description": "Aliases for the action.\nIndex alias names support date math.", + "name": "aliases", + "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataStreamIndex", - "namespace": "indices._types" + "items": [ + { + "kind": "instance_of", + "type": { + "name": "IndexAlias", + "namespace": "_types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "IndexAlias", + "namespace": "_types" + } + } } - } + ], + "kind": "union_of" } }, { - "name": "rollover_on_write", - "required": true, + "description": "Data stream or index for the action.\nSupports wildcards (`*`).", + "name": "index", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "IndexName", + "namespace": "_types" } } - } - ], - "specLocation": "indices/_types/DataStream.ts#L39-L43" - }, - { - "kind": "interface", - "name": { - "name": "DataStreamIndex", - "namespace": "indices._types" - }, - "properties": [ + }, { - "description": "Name of the backing index.", - "name": "index_name", - "required": true, + "description": "Data streams or indices for the action.\nSupports wildcards (`*`).", + "name": "indices", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "Indices", "namespace": "_types" } } }, { - "description": "Universally unique identifier (UUID) for the index.", - "name": "index_uuid", - "required": true, + "description": "If `true`, the alias must exist to perform the action.", + "name": "must_exist", + "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Uuid", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "indices/update_aliases/types.ts#L97-L122" + }, + { + "kind": "interface", + "name": { + "name": "RemoveIndexAction", + "namespace": "indices.update_aliases" + }, + "properties": [ { - "description": "Name of the current ILM lifecycle policy configured for this backing index.", - "name": "ilm_policy", + "description": "Data stream or index for the action.\nSupports wildcards (`*`).", + "name": "index", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "IndexName", "namespace": "_types" } } }, { - "description": "Name of the lifecycle system that's currently managing this backing index.", - "name": "managed_by", + "description": "Data streams or indices for the action.\nSupports wildcards (`*`).", + "name": "indices", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ManagedBy", - "namespace": "indices._types" + "name": "Indices", + "namespace": "_types" } } }, { - "description": "Indicates if ILM should take precedence over DSL in case both are configured to manage this index.", - "name": "prefer_ilm", + "description": "If `true`, the alias must exist to perform the action.", + "name": "must_exist", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -118887,123 +122037,108 @@ } } ], - "specLocation": "indices/_types/DataStream.ts#L136-L157" + "specLocation": "indices/update_aliases/types.ts#L124-L139" }, { "kind": "interface", "name": { - "name": "DataStreamTimestampField", - "namespace": "indices._types" + "name": "IndicesValidationExplanation", + "namespace": "indices.validate_query" }, "properties": [ { - "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.", - "name": "name", - "required": true, + "name": "error", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "explanation", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "indices/_types/DataStream.ts#L129-L134" - }, - { - "kind": "interface", - "name": { - "name": "IndexTemplateItem", - "namespace": "indices.get_index_template" - }, - "properties": [ + }, { - "name": "name", + "name": "index", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "IndexName", "namespace": "_types" } } }, { - "name": "index_template", + "name": "valid", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexTemplate", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "indices/get_index_template/IndicesGetIndexTemplateResponse.ts#L29-L32" + "specLocation": "indices/validate_query/IndicesValidateQueryResponse.ts#L32-L37" }, { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, "kind": "interface", "name": { - "name": "IndexTemplate", - "namespace": "indices._types" + "name": "RequestChatCompletionBase", + "namespace": "inference._types" }, "properties": [ { - "description": "Name of the index template.", - "name": "index_patterns", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Names", - "namespace": "_types" - } - } - }, - { - "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.", - "name": "composed_of", + "description": "A list of objects representing the conversation.", + "name": "messages", "required": true, "type": { "kind": "array_of", "value": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "Message", + "namespace": "inference.chat_completion_unified" } } } }, { - "description": "Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.", - "name": "template", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexTemplateSummary", - "namespace": "indices._types" - } - } - }, - { - "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.", - "name": "version", + "description": "The ID of the model to use.", + "name": "model", "required": false, "type": { "kind": "instance_of", "type": { - "name": "VersionNumber", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "priority", + "description": "The upper bound limit for the number of tokens that can be generated for a completion request.", + "name": "max_completion_tokens", "required": false, "type": { "kind": "instance_of", @@ -119014,1185 +122149,1136 @@ } }, { - "description": "Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch.", - "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", - "name": "_meta", + "description": "A sequence of strings to control when the model should stop generating additional tokens.", + "name": "stop", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "allow_auto_create", + "description": "The sampling temperature to use.", + "name": "temperature", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "float", + "namespace": "_types" } } }, { - "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.", - "name": "data_stream", + "description": "Controls which tool is called by the model.", + "name": "tool_choice", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexTemplateDataStreamConfiguration", - "namespace": "indices._types" + "name": "CompletionToolType", + "namespace": "inference.chat_completion_unified" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "8.12.0" - } - }, - "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.", - "name": "deprecated", + "description": "A list of tools that the model can call.", + "name": "tools", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CompletionTool", + "namespace": "inference.chat_completion_unified" + } } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "8.7.0" - } - }, - "description": "A list of component template names that are allowed to be absent.", - "name": "ignore_missing_component_templates", + "description": "Nucleus sampling, an alternative to sampling with temperature.", + "name": "top_p", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Names", + "name": "float", "namespace": "_types" } } } ], - "specLocation": "indices/_types/IndexTemplate.ts#L28-L81" + "specLocation": "inference/_types/CommonTypes.ts#L28-L61" }, { + "description": "An object representing part of the conversation.", "kind": "interface", "name": { - "name": "IndexTemplateSummary", - "namespace": "indices._types" + "name": "Message", + "namespace": "inference.chat_completion_unified" }, "properties": [ { - "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.", - "name": "aliases", + "description": "The content of the message.", + "name": "content", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Alias", - "namespace": "indices._types" - } + "kind": "instance_of", + "type": { + "name": "MessageContent", + "namespace": "inference.chat_completion_unified" } } }, { - "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.", - "name": "mappings", - "required": false, + "description": "The role of the message author.", + "name": "role", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Configuration options for the index.", - "name": "settings", + "description": "The tool call that this message is responding to.", + "name": "tool_call_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettings", - "namespace": "indices._types" + "name": "Id", + "namespace": "_types" } } }, { - "availability": { - "serverless": { - "stability": "stable" - }, - "stack": { - "since": "8.11.0", - "stability": "stable" - } - }, - "name": "lifecycle", + "description": "The tool calls generated by the model.", + "name": "tool_calls", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "DataStreamLifecycleWithRollover", - "namespace": "indices._types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "ToolCall", + "namespace": "inference.chat_completion_unified" + } } } } ], - "specLocation": "indices/_types/IndexTemplate.ts#L96-L118" + "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L110-L130" }, { + "description": "A tool call generated by the model.", "kind": "interface", "name": { - "name": "IndexTemplateDataStreamConfiguration", - "namespace": "indices._types" + "name": "ToolCall", + "namespace": "inference.chat_completion_unified" }, "properties": [ { - "description": "If true, the data stream is hidden.", - "name": "hidden", - "required": false, - "serverDefault": false, + "description": "The identifier of the tool call.", + "name": "id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "description": "If true, the data stream supports custom routing.", - "name": "allow_custom_routing", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "indices/_types/IndexTemplate.ts#L83-L94" - }, - { - "kind": "interface", - "name": { - "name": "IndexMappingRecord", - "namespace": "indices.get_mapping" - }, - "properties": [ - { - "name": "item", - "required": false, + "description": "The function that the model called.", + "name": "function", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "ToolCallFunction", + "namespace": "inference.chat_completion_unified" } } }, { - "name": "mappings", + "description": "The type of the tool call.", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "indices/get_mapping/IndicesGetMappingResponse.ts#L29-L32" + "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L87-L103" }, { + "description": "The function that the model called.", "kind": "interface", "name": { - "name": "Action", - "namespace": "indices.modify_data_stream" + "name": "ToolCallFunction", + "namespace": "inference.chat_completion_unified" }, "properties": [ { - "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.", - "name": "add_backing_index", - "required": false, + "description": "The arguments to call the function with in JSON format.", + "name": "arguments", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexAndDataStreamAction", - "namespace": "indices.modify_data_stream" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "remove_backing_index", - "required": false, + "description": "The name of the function to call.", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexAndDataStreamAction", - "namespace": "indices.modify_data_stream" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "indices/modify_data_stream/types.ts#L22-L37", - "variants": { - "kind": "container" - } + "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L73-L85" }, { + "description": "A list of tools that the model can call.", "kind": "interface", "name": { - "name": "IndexAndDataStreamAction", - "namespace": "indices.modify_data_stream" + "name": "CompletionTool", + "namespace": "inference.chat_completion_unified" }, "properties": [ { - "description": "Data stream targeted by the action.", - "name": "data_stream", + "description": "The type of tool.", + "name": "type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "DataStreamName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Index for the action.", - "name": "index", + "description": "The function definition.", + "name": "function", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "CompletionToolFunction", + "namespace": "inference.chat_completion_unified" } } } ], - "specLocation": "indices/modify_data_stream/types.ts#L39-L44" + "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L180-L192" }, { + "description": "The completion tool function definition.", "kind": "interface", "name": { - "name": "IndexTemplateMapping", - "namespace": "indices.put_index_template" + "name": "CompletionToolFunction", + "namespace": "inference.chat_completion_unified" }, "properties": [ { - "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.", - "name": "aliases", + "description": "A description of what the function does.\nThis is used by the model to choose when and how to call the function.", + "name": "description", "required": false, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Alias", - "namespace": "indices._types" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters.", - "name": "mappings", - "required": false, + "description": "The name of the function.", + "name": "name", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Configuration options for the index.", - "name": "settings", + "description": "The parameters the functional accepts. This should be formatted as a JSON object.", + "name": "parameters", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "IndexSettings", - "namespace": "indices._types" - } + "kind": "user_defined_value" } }, { - "availability": { - "serverless": { - "stability": "stable" - }, - "stack": { - "since": "8.11.0", - "stability": "stable" - } - }, - "name": "lifecycle", + "description": "Whether to enable schema adherence when generating the function call.", + "name": "strict", "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamLifecycle", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L159-L181" + "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L157-L178" }, { + "description": "Defines the completion result.", "kind": "interface", "name": { - "name": "DataStreamVisibility", - "namespace": "indices._types" + "name": "CompletionInferenceResult", + "namespace": "inference._types" }, "properties": [ { - "name": "hidden", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "allow_custom_routing", - "required": false, + "name": "completion", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "CompletionResult", + "namespace": "inference._types" + } } } } ], - "specLocation": "indices/_types/DataStream.ts#L159-L162" + "specLocation": "inference/_types/Results.ts#L84-L89" }, { + "description": "The completion result object", "kind": "interface", "name": { - "name": "ShardsOperationResponseBase", - "namespace": "_types" + "name": "CompletionResult", + "namespace": "inference._types" }, "properties": [ { - "name": "_shards", - "required": false, + "name": "result", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ShardStatistics", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "_types/Base.ts#L142-L145" + "specLocation": "inference/_types/Results.ts#L77-L82" }, { + "description": "Acknowledged response. For dry_run, contains the list of pipelines which reference the inference endpoint", + "inherits": { + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + }, "kind": "interface", "name": { - "name": "ResolveIndexItem", - "namespace": "indices.resolve_index" + "name": "DeleteInferenceEndpointResult", + "namespace": "inference._types" }, "properties": [ { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "name": "aliases", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "attributes", + "name": "pipelines", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "data_stream", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DataStreamName", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } } ], - "specLocation": "indices/resolve_index/ResolveIndexResponse.ts#L30-L35" + "specLocation": "inference/_types/Results.ts#L110-L115" }, { + "description": "Represents an inference endpoint as returned by the GET API", + "inherits": { + "type": { + "name": "InferenceEndpoint", + "namespace": "inference._types" + } + }, "kind": "interface", "name": { - "name": "ResolveIndexAliasItem", - "namespace": "indices.resolve_index" + "name": "InferenceEndpointInfo", + "namespace": "inference._types" }, "properties": [ { - "name": "name", + "description": "The inference Id", + "name": "inference_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "indices", + "description": "The task type", + "name": "task_type", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "TaskType", + "namespace": "inference._types" } } } ], - "specLocation": "indices/resolve_index/ResolveIndexResponse.ts#L37-L40" + "specLocation": "inference/_types/Services.ts#L46-L58" }, { + "description": "Configuration options when storing the inference endpoint", "kind": "interface", "name": { - "name": "ResolveIndexDataStreamsItem", - "namespace": "indices.resolve_index" + "name": "InferenceEndpoint", + "namespace": "inference._types" }, "properties": [ { - "name": "name", - "required": true, + "description": "Chunking configuration object", + "name": "chunking_settings", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "DataStreamName", - "namespace": "_types" + "name": "InferenceChunkingSettings", + "namespace": "inference._types" } } }, { - "name": "timestamp_field", + "description": "The service type", + "name": "service", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "backing_indices", + "description": "Settings specific to the service", + "name": "service_settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "ServiceSettings", + "namespace": "inference._types" + } + } + }, + { + "description": "Task settings specific to the service and task type", + "name": "task_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TaskSettings", + "namespace": "inference._types" } } } ], - "specLocation": "indices/resolve_index/ResolveIndexResponse.ts#L42-L46" + "specLocation": "inference/_types/Services.ts#L24-L44" }, { + "description": "Chunking configuration object", + "inherits": { + "type": { + "name": "InferenceEndpoint", + "namespace": "inference._types" + } + }, "kind": "interface", "name": { - "name": "RolloverConditions", - "namespace": "indices.rollover" + "name": "InferenceChunkingSettings", + "namespace": "inference._types" }, "properties": [ { - "name": "min_age", + "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).", + "name": "max_chunk_size", "required": false, + "serverDefault": 250, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } }, { - "name": "max_age", + "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.", + "name": "overlap", "required": false, + "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "integer", "namespace": "_types" } } }, { - "name": "max_age_millis", + "description": "The number of overlapping sentences for chunks.\nIt is applicable only for a `sentence` chunking strategy.\nIt can be either `1` or `0`.", + "name": "sentence_overlap", "required": false, + "serverDefault": 1, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "DurationValue", + "name": "integer", "namespace": "_types" } } }, { - "name": "min_docs", + "description": "The chunking strategy: `sentence` or `word`.", + "name": "strategy", "required": false, + "serverDefault": "sentence", "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "inference/_types/Services.ts#L60-L89" + }, + { + "kind": "interface", + "name": { +<<<<<<< HEAD +======= + "name": "AlibabaCloudServiceSettings", + "namespace": "inference.put_alibabacloud" + }, + "properties": [ { - "name": "max_docs", - "required": false, + "description": "A valid API key for the AlibabaCloud AI Search API.", + "name": "api_key", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_size", - "required": false, + "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.", + "extDocId": "alibabacloud-api-keys", + "extDocUrl": "https://opensearch.console.aliyun.com/cn-shanghai/rag/api-key", + "name": "host", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_size_bytes", + "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`.", + "name": "rate_limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "RateLimitSetting", + "namespace": "inference._types" } } }, { - "name": "min_size", - "required": false, + "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`", + "name": "service_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "min_size_bytes", - "required": false, + "description": "The name of the workspace used for the inference task.", + "name": "workspace", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "inference/put_alibabacloud/PutAlibabaCloudRequest.ts#L93-L138" + }, + { + "kind": "interface", + "name": { + "name": "RateLimitSetting", + "namespace": "inference._types" + }, + "properties": [ { - "name": "max_primary_shard_size", + "description": "The number of requests allowed per minute.", + "name": "requests_per_minute", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", + "name": "integer", "namespace": "_types" } } - }, + } + ], + "specLocation": "inference/_types/Services.ts#L95-L100" + }, + { + "kind": "interface", + "name": { + "name": "AlibabaCloudTaskSettings", + "namespace": "inference.put_alibabacloud" + }, + "properties": [ { - "name": "max_primary_shard_size_bytes", + "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.", + "name": "input_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "min_primary_shard_size", + "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.", + "name": "return_token", "required": false, "type": { "kind": "instance_of", "type": { - "name": "ByteSize", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "inference/put_alibabacloud/PutAlibabaCloudRequest.ts#L140-L154" + }, + { + "kind": "interface", + "name": { + "name": "AmazonBedrockServiceSettings", + "namespace": "inference.put_amazonbedrock" + }, + "properties": [ { - "name": "min_primary_shard_size_bytes", - "required": false, + "description": "A valid AWS access key that has permissions to use Amazon Bedrock and access to models for inference requests.", + "name": "access_key", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "max_primary_shard_docs", - "required": false, + "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.", + "extDocId": "amazonbedrock-models", + "extDocUrl": "https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html", + "name": "model", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "min_primary_shard_docs", + "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", + "name": "provider", "required": false, "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - } - ], - "specLocation": "indices/rollover/types.ts#L24-L40" - }, - { - "kind": "interface", - "name": { - "name": "Overlapping", - "namespace": "indices.simulate_template" - }, - "properties": [ + }, { - "name": "name", + "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.", + "extDocId": "amazonbedrock-models", + "extDocUrl": "https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html", + "name": "region", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "index_patterns", + "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.", + "name": "rate_limit", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RateLimitSetting", + "namespace": "inference._types" + } + } + }, + { + "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.", + "extDocId": "amazonbedrock-secret-keys", + "extDocUrl": "https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html", + "name": "secret_key", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "indices/simulate_template/IndicesSimulateTemplateResponse.ts#L39-L42" + "specLocation": "inference/put_amazonbedrock/PutAmazonBedrockRequest.ts#L95-L137" }, { "kind": "interface", "name": { - "name": "Template", - "namespace": "indices.simulate_template" + "name": "AmazonBedrockTaskSettings", + "namespace": "inference.put_amazonbedrock" }, "properties": [ { - "name": "aliases", - "required": true, + "description": "For a `completion` task, it sets the maximum number for the output tokens to be generated.", + "name": "max_new_tokens", + "required": false, + "serverDefault": 64, "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Alias", - "namespace": "indices._types" - } + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } }, { - "name": "mappings", - "required": true, + "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.", + "name": "temperature", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" + "name": "float", + "namespace": "_types" } } }, { - "name": "settings", - "required": true, + "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.", + "name": "top_k", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexSettings", - "namespace": "indices._types" + "name": "float", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "top_p", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" } } } ], - "specLocation": "indices/simulate_template/IndicesSimulateTemplateResponse.ts#L33-L37" + "specLocation": "inference/put_amazonbedrock/PutAmazonBedrockRequest.ts#L139-L163" }, { "kind": "interface", "name": { - "name": "Action", - "namespace": "indices.update_aliases" + "name": "AnthropicServiceSettings", + "namespace": "inference.put_anthropic" }, "properties": [ { - "description": "Adds a data stream or index to an alias.\nIf the alias doesn’t exist, the `add` action creates it.", - "name": "add", - "required": false, + "description": "A valid API key for the Anthropic API.", + "name": "api_key", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "AddAction", - "namespace": "indices.update_aliases" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Removes a data stream or index from an alias.", - "name": "remove", - "required": false, + "description": "The name of the model to use for the inference task.\nRefer to the Anthropic documentation for the list of supported models.", + "extDocId": "anothropic-models", + "name": "model_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "RemoveAction", - "namespace": "indices.update_aliases" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Deletes an index.\nYou cannot use this action on aliases or data streams.", - "name": "remove_index", + "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.", + "name": "rate_limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "RemoveIndexAction", - "namespace": "indices.update_aliases" + "name": "RateLimitSetting", + "namespace": "inference._types" } } } ], - "specLocation": "indices/update_aliases/types.ts#L23-L39", - "variants": { - "kind": "container" - } + "specLocation": "inference/put_anthropic/PutAnthropicRequest.ts#L92-L108" }, { "kind": "interface", "name": { - "name": "AddAction", - "namespace": "indices.update_aliases" + "name": "AnthropicTaskSettings", + "namespace": "inference.put_anthropic" }, "properties": [ { - "description": "Alias for the action.\nIndex alias names support date math.", - "name": "alias", - "required": false, + "description": "For a `completion` task, it is the maximum number of tokens to generate before stopping.", + "name": "max_tokens", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexAlias", + "name": "integer", "namespace": "_types" } } }, { - "description": "Aliases for the action.\nIndex alias names support date math.", - "name": "aliases", - "required": false, - "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "IndexAlias", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexAlias", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" - } - }, - { - "description": "Query used to limit documents the alias can access.", - "name": "filter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "description": "Data stream or index for the action.\nSupports wildcards (`*`).", - "name": "index", + "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.", + "extDocId": "anthropic-messages", + "extDocUrl": "https://docs.anthropic.com/en/api/messages", + "name": "temperature", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "float", "namespace": "_types" } } }, { - "description": "Data streams or indices for the action.\nSupports wildcards (`*`).", - "name": "indices", + "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`.", + "name": "top_k", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "integer", "namespace": "_types" } } }, { - "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.", - "name": "index_routing", + "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`.", + "name": "top_p", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Routing", + "name": "float", "namespace": "_types" } } - }, + } + ], + "specLocation": "inference/put_anthropic/PutAnthropicRequest.ts#L110-L135" + }, + { + "kind": "interface", + "name": { + "name": "AzureAiStudioServiceSettings", + "namespace": "inference.put_azureaistudio" + }, + "properties": [ { - "description": "If `true`, the alias is hidden.", - "name": "is_hidden", - "required": false, - "serverDefault": false, + "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.", + "extDocId": "azureaistudio-api-keys", + "extDocUrl": "https://ai.azure.com/", + "name": "api_key", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "If `true`, sets the write index or data stream for the alias.", - "name": "is_write_index", - "required": false, + "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.", + "extDocId": "azureaistudio-endpoint-types", + "extDocUrl": "https://learn.microsoft.com/en-us/azure/ai-foundry/concepts/deployments-overview#billing-for-deploying-and-inferencing-llms-in-azure-ai-studio", + "name": "endpoint_type", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.", - "name": "routing", - "required": false, + "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.", + "name": "target", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "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.", - "name": "search_routing", - "required": false, + "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", + "name": "provider", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Routing", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "If `true`, the alias must exist to perform the action.", - "name": "must_exist", + "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.", + "name": "rate_limit", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "RateLimitSetting", + "namespace": "inference._types" } } } ], - "specLocation": "indices/update_aliases/types.ts#L41-L95" + "specLocation": "inference/put_azureaistudio/PutAzureAiStudioRequest.ts#L92-L134" }, { "kind": "interface", "name": { - "name": "RemoveAction", - "namespace": "indices.update_aliases" + "name": "AzureAiStudioTaskSettings", + "namespace": "inference.put_azureaistudio" }, "properties": [ { - "description": "Alias for the action.\nIndex alias names support date math.", - "name": "alias", + "description": "For a `completion` task, instruct the inference process to perform sampling.\nIt has no effect unless `temperature` or `top_p` is specified.", + "name": "do_sample", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexAlias", + "name": "float", "namespace": "_types" } } }, { - "description": "Aliases for the action.\nIndex alias names support date math.", - "name": "aliases", + "description": "For a `completion` task, provide a hint for the maximum number of output tokens to be generated.", + "name": "max_new_tokens", "required": false, + "serverDefault": 64, "type": { - "items": [ - { - "kind": "instance_of", - "type": { - "name": "IndexAlias", - "namespace": "_types" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "IndexAlias", - "namespace": "_types" - } - } - } - ], - "kind": "union_of" + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } } }, { - "description": "Data stream or index for the action.\nSupports wildcards (`*`).", - "name": "index", + "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.", + "name": "temperature", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "float", "namespace": "_types" } } }, { - "description": "Data streams or indices for the action.\nSupports wildcards (`*`).", - "name": "indices", + "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.", + "name": "top_p", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Indices", + "name": "float", "namespace": "_types" } } }, { - "description": "If `true`, the alias must exist to perform the action.", - "name": "must_exist", + "description": "For a `text_embedding` task, specify the user issuing the request.\nThis information can be used for abuse detection.", + "name": "user", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "indices/update_aliases/types.ts#L97-L122" + "specLocation": "inference/put_azureaistudio/PutAzureAiStudioRequest.ts#L136-L164" }, { "kind": "interface", "name": { - "name": "RemoveIndexAction", - "namespace": "indices.update_aliases" + "name": "AzureOpenAIServiceSettings", + "namespace": "inference.put_azureopenai" }, "properties": [ { - "description": "Data stream or index for the action.\nSupports wildcards (`*`).", - "name": "index", + "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.", + "extDocId": "azureopenai-auth", + "extDocUrl": "https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#authentication", + "name": "api_key", "required": false, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Data streams or indices for the action.\nSupports wildcards (`*`).", - "name": "indices", - "required": false, + "description": "The Azure API version ID to use.\nIt is recommended to use the latest supported non-preview version.", + "name": "api_version", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Indices", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "If `true`, the alias must exist to perform the action.", - "name": "must_exist", - "required": false, - "serverDefault": false, + "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.", + "extDocId": "azureopenai", + "extDocUrl": "https://oai.azure.com/", + "name": "deployment_id", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } - } - ], - "specLocation": "indices/update_aliases/types.ts#L124-L139" - }, - { - "kind": "interface", - "name": { - "name": "IndicesValidationExplanation", - "namespace": "indices.validate_query" - }, - "properties": [ + }, { - "name": "error", + "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.", + "extDocId": "azureopenai-auth", + "extDocUrl": "https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#authentication", + "name": "entra_id", "required": false, "type": { "kind": "instance_of", @@ -120203,76 +123289,71 @@ } }, { - "name": "explanation", + "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`.", + "extDocId": "azureopenai-quota-limits", + "extDocUrl": "https://learn.microsoft.com/en-us/azure/ai-services/openai/quotas-limits", + "name": "rate_limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "RateLimitSetting", + "namespace": "inference._types" } } }, { - "name": "index", + "description": "The name of your Azure OpenAI resource.\nYou can find this from the list of resources in the Azure Portal for your subscription.", + "extDocId": "azureopenai-portal", + "extDocUrl": "https://portal.azure.com/#view/HubsExtension/BrowseAll", + "name": "resource_name", "required": true, "type": { "kind": "instance_of", "type": { - "name": "IndexName", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, + } + ], + "specLocation": "inference/put_azureopenai/PutAzureOpenAiRequest.ts#L99-L144" + }, + { + "kind": "interface", + "name": { + "name": "AzureOpenAITaskSettings", + "namespace": "inference.put_azureopenai" + }, + "properties": [ { - "name": "valid", - "required": true, + "description": "For a `completion` or `text_embedding` task, specify the user issuing the request.\nThis information can be used for abuse detection.", + "name": "user", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "indices/validate_query/IndicesValidateQueryResponse.ts#L32-L37" + "specLocation": "inference/put_azureopenai/PutAzureOpenAiRequest.ts#L146-L152" }, { - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, "kind": "interface", "name": { - "name": "RequestChatCompletionBase", - "namespace": "inference._types" + "name": "CohereServiceSettings", + "namespace": "inference.put_cohere" }, "properties": [ { - "description": "A list of objects representing the conversation.", - "name": "messages", + "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.", + "extDocId": "cohere-api-keys", + "extDocUrl": "https://dashboard.cohere.com/api-keys", + "name": "api_key", "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Message", - "namespace": "inference.chat_completion_unified" - } - } - } - }, - { - "description": "The ID of the model to use.", - "name": "model", - "required": false, "type": { "kind": "instance_of", "type": { @@ -120282,219 +123363,172 @@ } }, { - "description": "The upper bound limit for the number of tokens that can be generated for a completion request.", - "name": "max_completion_tokens", + "description": "For a `text_embedding` task, the types of embeddings you want to get back.\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.", + "name": "embedding_type", "required": false, + "serverDefault": "float", "type": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "A sequence of strings to control when the model should stop generating additional tokens.", - "name": "stop", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "name": "EmbeddingType", + "namespace": "inference.put_cohere" } } }, { - "description": "The sampling temperature to use.", - "name": "temperature", + "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).\n\nThe default value for a text embedding task is `embed-english-v2.0`.", + "name": "model_id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Controls which tool is called by the model.", - "name": "tool_choice", + "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.", + "name": "rate_limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "CompletionToolType", - "namespace": "inference.chat_completion_unified" - } - } - }, - { - "description": "A list of tools that the model can call.", - "name": "tools", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CompletionTool", - "namespace": "inference.chat_completion_unified" - } + "name": "RateLimitSetting", + "namespace": "inference._types" } } }, { - "description": "Nucleus sampling, an alternative to sampling with temperature.", - "name": "top_p", + "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`.", + "name": "similarity", "required": false, "type": { "kind": "instance_of", "type": { - "name": "float", - "namespace": "_types" + "name": "SimilarityType", + "namespace": "inference.put_cohere" } } } ], - "specLocation": "inference/_types/CommonTypes.ts#L28-L61" + "specLocation": "inference/put_cohere/PutCohereRequest.ts#L119-L160" }, { - "description": "An object representing part of the conversation.", "kind": "interface", "name": { - "name": "Message", - "namespace": "inference.chat_completion_unified" + "name": "CohereTaskSettings", + "namespace": "inference.put_cohere" }, "properties": [ { - "description": "The content of the message.", - "name": "content", + "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.", + "name": "input_type", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MessageContent", - "namespace": "inference.chat_completion_unified" + "name": "InputType", + "namespace": "inference.put_cohere" } } }, { - "description": "The role of the message author.", - "name": "role", - "required": true, + "description": "For a `rerank` task, return doc text within the results.", + "name": "return_documents", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "The tool call that this message is responding to.", - "name": "tool_call_id", + "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.", + "name": "top_n", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", + "name": "integer", "namespace": "_types" } } }, { - "description": "The tool calls generated by the model.", - "name": "tool_calls", + "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.", + "name": "truncate", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ToolCall", - "namespace": "inference.chat_completion_unified" - } + "kind": "instance_of", + "type": { + "name": "TruncateType", + "namespace": "inference.put_cohere" } } } ], - "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L110-L130" + "specLocation": "inference/put_cohere/PutCohereRequest.ts#L162-L194" }, { - "description": "A tool call generated by the model.", "kind": "interface", "name": { - "name": "ToolCall", - "namespace": "inference.chat_completion_unified" + "name": "EisServiceSettings", + "namespace": "inference.put_eis" }, "properties": [ { - "description": "The identifier of the tool call.", - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "The function that the model called.", - "name": "function", + "description": "The name of the model to use for the inference task.", + "name": "model_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ToolCallFunction", - "namespace": "inference.chat_completion_unified" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The type of the tool call.", - "name": "type", - "required": true, + "description": "This setting helps to minimize the number of rate limit errors returned.\nBy default, the `elastic` service sets the number of requests allowed per minute to `240` in case of `chat_completion`.", + "name": "rate_limit", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "RateLimitSetting", + "namespace": "inference._types" } } } ], - "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L87-L103" + "specLocation": "inference/put_eis/PutEisRequest.ts#L72-L82" }, { - "description": "The function that the model called.", "kind": "interface", "name": { - "name": "ToolCallFunction", - "namespace": "inference.chat_completion_unified" + "name": "ElasticsearchServiceSettings", + "namespace": "inference.put_elasticsearch" }, "properties": [ { - "description": "The arguments to call the function with in JSON format.", - "name": "arguments", - "required": true, + "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.", + "name": "adaptive_allocations", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "AdaptiveAllocations", + "namespace": "inference.put_elasticsearch" } } }, { - "description": "The name of the function to call.", - "name": "name", - "required": true, + "description": "The deployment identifier for a trained model deployment.\nWhen `deployment_id` is used the `model_id` is optional.", + "name": "deployment_id", + "required": false, "type": { "kind": "instance_of", "type": { @@ -120502,21 +123536,12 @@ "namespace": "_builtins" } } - } - ], - "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L73-L85" - }, - { - "description": "A list of tools that the model can call.", - "kind": "interface", - "name": { - "name": "CompletionTool", - "namespace": "inference.chat_completion_unified" - }, - "properties": [ + }, { - "description": "The type of tool.", - "name": "type", + "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.", + "extDocId": "eland-import", + "extDocUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-import-model.html#ml-nlp-import-script", + "name": "model_id", "required": true, "type": { "kind": "instance_of", @@ -120527,170 +123552,205 @@ } }, { - "description": "The function definition.", - "name": "function", + "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.", + "name": "num_allocations", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "num_threads", "required": true, "type": { "kind": "instance_of", "type": { - "name": "CompletionToolFunction", - "namespace": "inference.chat_completion_unified" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L180-L192" + "specLocation": "inference/put_elasticsearch/PutElasticsearchRequest.ts#L117-L151" }, { - "description": "The completion tool function definition.", "kind": "interface", "name": { - "name": "CompletionToolFunction", - "namespace": "inference.chat_completion_unified" + "name": "AdaptiveAllocations", + "namespace": "inference.put_elasticsearch" }, "properties": [ { - "description": "A description of what the function does.\nThis is used by the model to choose when and how to call the function.", - "name": "description", + "description": "Turn on `adaptive_allocations`.", + "name": "enabled", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "The name of the function.", - "name": "name", - "required": true, + "description": "The maximum number of allocations to scale to.\nIf set, it must be greater than or equal to `min_number_of_allocations`.", + "name": "max_number_of_allocations", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } }, { - "description": "The parameters the functional accepts. This should be formatted as a JSON object.", - "name": "parameters", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "description": "Whether to enable schema adherence when generating the function call.", - "name": "strict", + "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.", + "name": "min_number_of_allocations", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "inference/chat_completion_unified/UnifiedRequest.ts#L157-L178" + "specLocation": "inference/put_elasticsearch/PutElasticsearchRequest.ts#L98-L115" }, { - "description": "Defines the completion result.", "kind": "interface", "name": { - "name": "CompletionInferenceResult", - "namespace": "inference._types" + "name": "ElasticsearchTaskSettings", + "namespace": "inference.put_elasticsearch" }, "properties": [ { - "name": "completion", - "required": true, + "description": "For a `rerank` task, return the document instead of only the index.", + "name": "return_documents", + "required": false, + "serverDefault": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CompletionResult", - "namespace": "inference._types" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } } ], - "specLocation": "inference/_types/Results.ts#L84-L89" + "specLocation": "inference/put_elasticsearch/PutElasticsearchRequest.ts#L153-L159" }, { - "description": "The completion result object", "kind": "interface", "name": { - "name": "CompletionResult", - "namespace": "inference._types" + "name": "ElserServiceSettings", + "namespace": "inference.put_elser" }, "properties": [ { - "name": "result", + "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.", + "name": "adaptive_allocations", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AdaptiveAllocations", + "namespace": "inference.put_elser" + } + } + }, + { + "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.", + "name": "num_allocations", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "integer", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "num_threads", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "inference/_types/Results.ts#L77-L82" + "specLocation": "inference/put_elser/PutElserRequest.ts#L111-L137" }, { - "description": "Acknowledged response. For dry_run, contains the list of pipelines which reference the inference endpoint", - "inherits": { - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - }, "kind": "interface", "name": { - "name": "DeleteInferenceEndpointResult", - "namespace": "inference._types" + "name": "AdaptiveAllocations", + "namespace": "inference.put_elser" }, "properties": [ { - "name": "pipelines", - "required": true, + "description": "Turn on `adaptive_allocations`.", + "name": "enabled", + "required": false, + "serverDefault": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The maximum number of allocations to scale to.\nIf set, it must be greater than or equal to `min_number_of_allocations`.", + "name": "max_number_of_allocations", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "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.", + "name": "min_number_of_allocations", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" } } } ], - "specLocation": "inference/_types/Results.ts#L110-L115" + "specLocation": "inference/put_elser/PutElserRequest.ts#L92-L109" }, { - "description": "Represents an inference endpoint as returned by the GET API", - "inherits": { - "type": { - "name": "InferenceEndpoint", - "namespace": "inference._types" - } - }, "kind": "interface", "name": { - "name": "InferenceEndpointInfo", - "namespace": "inference._types" + "name": "GoogleAiStudioServiceSettings", + "namespace": "inference.put_googleaistudio" }, "properties": [ { - "description": "The inference Id", - "name": "inference_id", + "description": "A valid API key of your Google Gemini account.", + "name": "api_key", "required": true, "type": { "kind": "instance_of", @@ -120701,43 +123761,60 @@ } }, { - "description": "The task type", - "name": "task_type", + "description": "The name of the model to use for the inference task.\nRefer to the Google documentation for the list of supported models.", + "extDocId": "googleaistudio-models", + "extDocUrl": "https://ai.google.dev/gemini-api/docs/models", + "name": "model_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "TaskType", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "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.", + "name": "rate_limit", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RateLimitSetting", "namespace": "inference._types" } } } ], - "specLocation": "inference/_types/Services.ts#L46-L58" + "specLocation": "inference/put_googleaistudio/PutGoogleAiStudioRequest.ts#L86-L102" }, { - "description": "Configuration options when storing the inference endpoint", "kind": "interface", "name": { - "name": "InferenceEndpoint", - "namespace": "inference._types" + "name": "GoogleVertexAIServiceSettings", + "namespace": "inference.put_googlevertexai" }, "properties": [ { - "description": "Chunking configuration object", - "name": "chunking_settings", - "required": false, + "description": "The name of the location to use for the inference task.\nRefer to the Google documentation for the list of supported locations.", + "extDocId": "googlevertexai-locations", + "extDocUrl": "https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations", + "name": "location", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "InferenceChunkingSettings", - "namespace": "inference._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The service type", - "name": "service", + "description": "The name of the model to use for the inference task.\nRefer to the Google documentation for the list of supported models.", + "extDocId": "googlevertexai-models", + "extDocUrl": "https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/text-embeddings-api", + "name": "model_id", "required": true, "type": { "kind": "instance_of", @@ -120748,77 +123825,67 @@ } }, { - "description": "Settings specific to the service", - "name": "service_settings", + "description": "The name of the project to use for the inference task.", + "name": "project_id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "ServiceSettings", - "namespace": "inference._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Task settings specific to the service and task type", - "name": "task_settings", + "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.", + "name": "rate_limit", "required": false, "type": { "kind": "instance_of", "type": { - "name": "TaskSettings", + "name": "RateLimitSetting", "namespace": "inference._types" } } + }, + { + "description": "A valid service account in JSON format for the Google Vertex AI API.", + "name": "service_account_json", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "inference/_types/Services.ts#L24-L44" + "specLocation": "inference/put_googlevertexai/PutGoogleVertexAiRequest.ts#L92-L118" }, { - "description": "Chunking configuration object", - "inherits": { - "type": { - "name": "InferenceEndpoint", - "namespace": "inference._types" - } - }, "kind": "interface", "name": { - "name": "InferenceChunkingSettings", - "namespace": "inference._types" + "name": "GoogleVertexAITaskSettings", + "namespace": "inference.put_googlevertexai" }, "properties": [ { - "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).", - "name": "max_chunk_size", - "required": false, - "serverDefault": 250, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "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.", - "name": "overlap", + "description": "For a `text_embedding` task, truncate inputs longer than the maximum token length automatically.", + "name": "auto_truncate", "required": false, - "serverDefault": 100, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The number of overlapping sentences for chunks.\nIt is applicable only for a `sentence` chunking strategy.\nIt can be either `1` or `0`.", - "name": "sentence_overlap", + "description": "For a `rerank` task, the number of the top N documents that should be returned.", + "name": "top_n", "required": false, - "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -120826,26 +123893,14 @@ "namespace": "_types" } } - }, - { - "description": "The chunking strategy: `sentence` or `word`.", - "name": "strategy", - "required": false, - "serverDefault": "sentence", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } } ], - "specLocation": "inference/_types/Services.ts#L60-L89" + "specLocation": "inference/put_googlevertexai/PutGoogleVertexAiRequest.ts#L120-L129" }, { "kind": "interface", "name": { +>>>>>>> ef980f023 (Add Alibaba Cloud inference API (#4021)) "name": "HuggingFaceServiceSettings", "namespace": "inference.put_hugging_face" }, diff --git a/output/schema/schema.json b/output/schema/schema.json index 4fa074c317..72538adc54 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -9303,6 +9303,51 @@ } ] }, + { + "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, + "stack": { + "since": "8.16.0", + "stability": "stable", + "visibility": "public" + } + }, + "description": "Create an AlibabaCloud AI Search inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", + "docId": "inference-api-put-alibabacloud", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-alibabacloud-ai-search.html", + "name": "inference.put_alibabacloud", + "privileges": { + "cluster": [ + "manage_inference" + ] + }, + "request": { + "name": "Request", + "namespace": "inference.put_alibabacloud" + }, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "inference.put_alibabacloud" + }, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{alibabacloud_inference_id}" + } + ] + }, { "availability": { "serverless": { @@ -150427,6 +150472,287 @@ }, "specLocation": "inference/put/PutResponse.ts#L22-L24" }, + { + "kind": "interface", + "name": { + "name": "AlibabaCloudServiceSettings", + "namespace": "inference.put_alibabacloud" + }, + "properties": [ + { + "description": "A valid API key for the AlibabaCloud AI Search API.", + "name": "api_key", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "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.", + "extDocId": "alibabacloud-api-keys", + "extDocUrl": "https://opensearch.console.aliyun.com/cn-shanghai/rag/api-key", + "name": "host", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "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`.", + "name": "rate_limit", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RateLimitSetting", + "namespace": "inference._types" + } + } + }, + { + "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`", + "name": "service_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The name of the workspace used for the inference task.", + "name": "workspace", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "inference/put_alibabacloud/PutAlibabaCloudRequest.ts#L93-L138" + }, + { + "kind": "interface", + "name": { + "name": "AlibabaCloudTaskSettings", + "namespace": "inference.put_alibabacloud" + }, + "properties": [ + { + "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.", + "name": "input_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "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.", + "name": "return_token", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "inference/put_alibabacloud/PutAlibabaCloudRequest.ts#L140-L154" + }, + { + "kind": "enum", + "members": [ + { + "name": "completion" + }, + { + "name": "rerank" + }, + { + "name": "space_embedding" + }, + { + "name": "text_embedding" + } + ], + "name": { + "name": "AlibabaCloudTaskType", + "namespace": "inference.put_alibabacloud" + }, + "specLocation": "inference/put_alibabacloud/PutAlibabaCloudRequest.ts#L82-L87" + }, + { + "kind": "request", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "The chunking configuration object.", + "extDocId": "inference-chunking", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "name": "chunking_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "InferenceChunkingSettings", + "namespace": "inference._types" + } + } + }, + { + "description": "The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`.", + "name": "service", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "ServiceType", + "namespace": "inference.put_alibabacloud" + } + } + }, + { + "description": "Settings used to install the inference model. These settings are specific to the `alibabacloud-ai-search` service.", + "name": "service_settings", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AlibabaCloudServiceSettings", + "namespace": "inference.put_alibabacloud" + } + } + }, + { + "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", + "name": "task_settings", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "AlibabaCloudTaskSettings", + "namespace": "inference.put_alibabacloud" + } + } + } + ] + }, + "description": "Create an AlibabaCloud AI Search inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", + "examples": { + "PutAlibabaCloudRequestExample1": { + "description": "Run `PUT _inference/completion/alibabacloud_ai_search_completion` to create an inference endpoint that performs a completion task.", + "summary": "A completion task", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"host\" : \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-qwen-turbo\",\n \"workspace\" : \"default\"\n }\n}" + }, + "PutAlibabaCloudRequestExample2": { + "description": "Run `PUT _inference/rerank/alibabacloud_ai_search_rerank` to create an inference endpoint that performs a rerank task.", + "summary": "A rerank task", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-bge-reranker-larger\",\n \"host\": \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"workspace\": \"default\"\n }\n}" + }, + "PutAlibabaCloudRequestExample3": { + "description": "Run `PUT _inference/sparse_embedding/alibabacloud_ai_search_sparse` to create an inference endpoint that performs perform a sparse embedding task.", + "summary": "A sparse embedding task", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-text-sparse-embedding-001\",\n \"host\": \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"workspace\": \"default\"\n }\n}" + }, + "PutAlibabaCloudRequestExample4": { + "description": "Run `PUT _inference/text_embedding/alibabacloud_ai_search_embeddings` to create an inference endpoint that performs a text embedding task.", + "summary": "A text embedding task", + "value": "{\n \"service\": \"alibabacloud-ai-search\",\n \"service_settings\": {\n \"api_key\": \"AlibabaCloud-API-Key\",\n \"service_id\": \"ops-text-embedding-001\",\n \"host\": \"default-j01.platform-cn-shanghai.opensearch.aliyuncs.com\",\n \"workspace\": \"default\"\n }\n}" + } + }, + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "name": { + "name": "Request", + "namespace": "inference.put_alibabacloud" + }, + "path": [ + { + "description": "The type of the inference task that the model will perform.", + "name": "task_type", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "AlibabaCloudTaskType", + "namespace": "inference.put_alibabacloud" + } + } + }, + { + "description": "The unique identifier of the inference endpoint.", + "name": "alibabacloud_inference_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "inference/put_alibabacloud/PutAlibabaCloudRequest.ts#L27-L80" + }, + { + "kind": "response", + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "InferenceEndpointInfo", + "namespace": "inference._types" + } + } + }, + "name": { + "name": "Response", + "namespace": "inference.put_alibabacloud" + }, + "specLocation": "inference/put_alibabacloud/PutAlibabaCloudResponse.ts#L22-L24" + }, + { + "kind": "enum", + "members": [ + { + "name": "alibabacloud-ai-search" + } + ], + "name": { + "name": "ServiceType", + "namespace": "inference.put_alibabacloud" + }, + "specLocation": "inference/put_alibabacloud/PutAlibabaCloudRequest.ts#L89-L91" + }, { "kind": "interface", "name": { diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 1eab8efef9..e123644ad8 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -13247,6 +13247,36 @@ export interface InferencePutRequest extends RequestBase { export type InferencePutResponse = InferenceInferenceEndpointInfo +export interface InferencePutAlibabacloudAlibabaCloudServiceSettings { + api_key: string + host: string + rate_limit?: InferenceRateLimitSetting + service_id: string + workspace: string +} + +export interface InferencePutAlibabacloudAlibabaCloudTaskSettings { + input_type?: string + return_token?: boolean +} + +export type InferencePutAlibabacloudAlibabaCloudTaskType = 'completion' | 'rerank' | 'space_embedding' | 'text_embedding' + +export interface InferencePutAlibabacloudRequest extends RequestBase { + task_type: InferencePutAlibabacloudAlibabaCloudTaskType + alibabacloud_inference_id: Id + body?: { + chunking_settings?: InferenceInferenceChunkingSettings + service: InferencePutAlibabacloudServiceType + service_settings: InferencePutAlibabacloudAlibabaCloudServiceSettings + task_settings?: InferencePutAlibabacloudAlibabaCloudTaskSettings + } +} + +export type InferencePutAlibabacloudResponse = InferenceInferenceEndpointInfo + +export type InferencePutAlibabacloudServiceType = 'alibabacloud-ai-search' + export interface InferencePutHuggingFaceHuggingFaceServiceSettings { api_key: string rate_limit?: InferenceRateLimitSetting diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 14c73a4269..ab72997bf8 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -2,6 +2,7 @@ apis,https://www.elastic.co/docs/api/doc/elasticsearch add-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/current/add-elasticsearch-nodes.html alias-update,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-alias aliases-update,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases +alibabacloud-api-keys,https://opensearch.console.aliyun.com/cn-shanghai/rag/api-key analysis-analyzers,https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-analyzers.html analysis-charfilters,https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html analysis-normalizers,https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html @@ -314,11 +315,16 @@ indices-templates,https://www.elastic.co/guide/en/elasticsearch/reference/curren indices-update-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings infer-trained-model,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-infer-trained-model infer-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-trained-model-deployment.html +inference-api-amazonbedrock,https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-amazon-bedrock.html inference-api-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-delete inference-api-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-get inference-api-post,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference inference-api-post-eis-chat-completion,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-post-eis-chat-completion inference-api-put,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put +inference-api-put-alibabacloud,https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-alibabacloud-ai-search.html +inference-api-put-azureaistudio,https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-azure-ai-studio.html +inference-api-put-azureopenai,https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-azure-openai.html +inference-api-put-cohere,https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-cohere.html inference-api-put-eis,https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-eis.html inference-api-put-huggingface,https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-hugging-face.html inference-api-put-jinaai,https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-jinaai.html diff --git a/specification/_json_spec/inference.put_alibabacloud.json b/specification/_json_spec/inference.put_alibabacloud.json new file mode 100644 index 0000000000..b39d5abe97 --- /dev/null +++ b/specification/_json_spec/inference.put_alibabacloud.json @@ -0,0 +1,35 @@ +{ + "inference.put_alibabacloud": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-alibabacloud-ai-search.html", + "description": "Configure an AlibabaCloud AI Search inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{alibabacloud_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "alibabacloud_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +} diff --git a/specification/inference/put_alibabacloud/PutAlibabaCloudRequest.ts b/specification/inference/put_alibabacloud/PutAlibabaCloudRequest.ts new file mode 100644 index 0000000000..11770daa84 --- /dev/null +++ b/specification/inference/put_alibabacloud/PutAlibabaCloudRequest.ts @@ -0,0 +1,154 @@ +/* + * 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 { + InferenceChunkingSettings, + RateLimitSetting +} from '@inference/_types/Services' +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' + +/** + * Create an AlibabaCloud AI Search inference endpoint. + * + * Create an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service. + * + * When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + * After creating the endpoint, wait for the model deployment to complete before using it. + * To verify the deployment status, use the get trained model statistics API. + * Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. + * Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + * @rest_spec_name inference.put_alibabacloud + * @availability stack since=8.16.0 stability=stable visibility=public + * @availability serverless stability=stable visibility=public + * @cluster_privileges manage_inference + * @doc_id inference-api-put-alibabacloud + */ +export interface Request extends RequestBase { + urls: [ + { + path: '/_inference/{task_type}/{alibabacloud_inference_id}' + methods: ['PUT'] + } + ] + path_parts: { + /** + * The type of the inference task that the model will perform. + */ + task_type: AlibabaCloudTaskType + /** + * The unique identifier of the inference endpoint. + */ + alibabacloud_inference_id: Id + } + body: { + /** + * The chunking configuration object. + * @ext_doc_id inference-chunking + */ + chunking_settings?: InferenceChunkingSettings + /** + * The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`. + */ + service: ServiceType + /** + * Settings used to install the inference model. These settings are specific to the `alibabacloud-ai-search` service. + */ + service_settings: AlibabaCloudServiceSettings + /** + * Settings to configure the inference task. + * These settings are specific to the task type you specified. + */ + task_settings?: AlibabaCloudTaskSettings + } +} + +export enum AlibabaCloudTaskType { + completion, + rerank, + space_embedding, + text_embedding +} + +export enum ServiceType { + 'alibabacloud-ai-search' +} + +export class AlibabaCloudServiceSettings { + /** + * A valid API key for the AlibabaCloud AI Search API. + */ + api_key: string + /** + * The name of the host address used for the inference task. + * You can find the host address in the API keys section of the documentation. + * @ext_doc_id alibabacloud-api-keys + */ + host: string + /** + * This setting helps to minimize the number of rate limit errors returned from AlibabaCloud AI Search. + * By default, the `alibabacloud-ai-search` service sets the number of requests allowed per minute to `1000`. + */ + rate_limit?: RateLimitSetting + /** + * The name of the model service to use for the inference task. + * The following service IDs are available for the `completion` task: + * + * * `ops-qwen-turbo` + * * `qwen-turbo` + * * `qwen-plus` + * * `qwen-max ÷ qwen-max-longcontext` + * + * The following service ID is available for the `rerank` task: + * + * * `ops-bge-reranker-larger` + * + * The following service ID is available for the `sparse_embedding` task: + * + * * `ops-text-sparse-embedding-001` + * + * The following service IDs are available for the `text_embedding` task: + * + * `ops-text-embedding-001` + * `ops-text-embedding-zh-001` + * `ops-text-embedding-en-001` + * `ops-text-embedding-002` + */ + service_id: string + /** + * The name of the workspace used for the inference task. + */ + workspace: string +} + +export class AlibabaCloudTaskSettings { + /** + * For a `sparse_embedding` or `text_embedding` task, specify the type of input passed to the model. + * Valid values are: + * + * * `ingest` for storing document embeddings in a vector database. + * * `search` for storing embeddings of search queries run against a vector database to find relevant documents. + */ + input_type?: string + /** + * For a `sparse_embedding` task, it affects whether the token name will be returned in the response. + * It defaults to `false`, which means only the token ID will be returned in the response. + */ + return_token?: boolean +} diff --git a/specification/inference/put_alibabacloud/PutAlibabaCloudResponse.ts b/specification/inference/put_alibabacloud/PutAlibabaCloudResponse.ts new file mode 100644 index 0000000000..d40639b031 --- /dev/null +++ b/specification/inference/put_alibabacloud/PutAlibabaCloudResponse.ts @@ -0,0 +1,24 @@ +/* + * 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 { InferenceEndpointInfo } from '@inference/_types/Services' + +export class Response { + body: InferenceEndpointInfo +} diff --git a/specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample1.yaml b/specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample1.yaml new file mode 100644 index 0000000000..4a939a2ee2 --- /dev/null +++ b/specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample1.yaml @@ -0,0 +1,14 @@ +summary: A completion task +description: Run `PUT _inference/completion/alibabacloud_ai_search_completion` to create an inference endpoint that performs a completion task. +# method_request: "PUT _inference/completion/alibabacloud_ai_search_completion" +# type: "request" +value: |- + { + "service": "alibabacloud-ai-search", + "service_settings": { + "host" : "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com", + "api_key": "AlibabaCloud-API-Key", + "service_id": "ops-qwen-turbo", + "workspace" : "default" + } + } diff --git a/specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample2.yaml b/specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample2.yaml new file mode 100644 index 0000000000..1a4f9a832d --- /dev/null +++ b/specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample2.yaml @@ -0,0 +1,14 @@ +summary: A rerank task +description: Run `PUT _inference/rerank/alibabacloud_ai_search_rerank` to create an inference endpoint that performs a rerank task. +# method_request: "PUT _inference/rerank/alibabacloud_ai_search_rerank" +# type: "request" +value: |- + { + "service": "alibabacloud-ai-search", + "service_settings": { + "api_key": "AlibabaCloud-API-Key", + "service_id": "ops-bge-reranker-larger", + "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com", + "workspace": "default" + } + } diff --git a/specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample3.yaml b/specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample3.yaml new file mode 100644 index 0000000000..c43ee4b6bf --- /dev/null +++ b/specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample3.yaml @@ -0,0 +1,14 @@ +summary: A sparse embedding task +description: Run `PUT _inference/sparse_embedding/alibabacloud_ai_search_sparse` to create an inference endpoint that performs perform a sparse embedding task. +# method_request: "PUT _inference/sparse_embedding/alibabacloud_ai_search_sparse" +# type: "request" +value: |- + { + "service": "alibabacloud-ai-search", + "service_settings": { + "api_key": "AlibabaCloud-API-Key", + "service_id": "ops-text-sparse-embedding-001", + "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com", + "workspace": "default" + } + } diff --git a/specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample4.yaml b/specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample4.yaml new file mode 100644 index 0000000000..17a76344fb --- /dev/null +++ b/specification/inference/put_alibabacloud/examples/request/PutAlibabaCloudRequestExample4.yaml @@ -0,0 +1,14 @@ +summary: A text embedding task +description: Run `PUT _inference/text_embedding/alibabacloud_ai_search_embeddings` to create an inference endpoint that performs a text embedding task. +# method_request: "PUT _inference/text_embedding/alibabacloud_ai_search_embeddings" +# type: "request" +value: |- + { + "service": "alibabacloud-ai-search", + "service_settings": { + "api_key": "AlibabaCloud-API-Key", + "service_id": "ops-text-embedding-001", + "host": "default-j01.platform-cn-shanghai.opensearch.aliyuncs.com", + "workspace": "default" + } + }