@elastic/elasticsearch 9.0.1 → 9.0.2

package/index.d.ts

@@ -8,6 +8,6 @@ import SniffingTransport from './lib/sniffingTransport'
 
 export * from '@elastic/transport'
 export * as estypes from './lib/api/types'
-export * as estypesWithBody from './lib/api/typesWithBodyKey'
 export { Client, SniffingTransport }
 export type { ClientOptions, NodeOptions } from './lib/client'
+export * as helpers from './lib/helpers'

package/lib/api/api/inference.d.ts

@@ -17,7 +17,7 @@ export default class Inference {
     }>;
     constructor(transport: Transport);
     /**
-      * Perform chat completion inference
+      * Perform chat completion inference The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. It only works with the `chat_completion` task type for `openai` and `elastic` inference services. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming. The Chat completion inference API and the Stream inference API differ in their response structure and capabilities. The Chat completion inference API provides more comprehensive customization options through more fields and function calling support. If you use the `openai` service or the `elastic` service, use the Chat completion inference API.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-unified-inference | Elasticsearch API documentation}
       */
     chatCompletionUnified(this: That, params: T.InferenceChatCompletionUnifiedRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferenceChatCompletionUnifiedResponse>;
@@ -52,49 +52,49 @@ export default class Inference {
     inference(this: That, params: T.InferenceInferenceRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferenceInferenceResponse, unknown>>;
     inference(this: That, params: T.InferenceInferenceRequest, options?: TransportRequestOptions): Promise<T.InferenceInferenceResponse>;
     /**
-      * Create an inference endpoint. 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. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
+      * Create an inference endpoint. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put | Elasticsearch API documentation}
       */
     put(this: That, params: T.InferencePutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutResponse>;
     put(this: That, params: T.InferencePutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutResponse, unknown>>;
     put(this: That, params: T.InferencePutRequest, options?: TransportRequestOptions): Promise<T.InferencePutResponse>;
     /**
-      * 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.
+      * Create an AlibabaCloud AI Search inference endpoint. Create an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-alibabacloud | Elasticsearch API documentation}
       */
     putAlibabacloud(this: That, params: T.InferencePutAlibabacloudRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutAlibabacloudResponse>;
     putAlibabacloud(this: That, params: T.InferencePutAlibabacloudRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutAlibabacloudResponse, unknown>>;
     putAlibabacloud(this: That, params: T.InferencePutAlibabacloudRequest, options?: TransportRequestOptions): Promise<T.InferencePutAlibabacloudResponse>;
     /**
-      * Create an Amazon Bedrock inference endpoint. Creates an inference endpoint to perform an inference task with the `amazonbedrock` service. >info > 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. 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.
+      * Create an Amazon Bedrock inference endpoint. Creates an inference endpoint to perform an inference task with the `amazonbedrock` service. >info > 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.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-amazonbedrock | Elasticsearch API documentation}
       */
     putAmazonbedrock(this: That, params: T.InferencePutAmazonbedrockRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutAmazonbedrockResponse>;
     putAmazonbedrock(this: That, params: T.InferencePutAmazonbedrockRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutAmazonbedrockResponse, unknown>>;
     putAmazonbedrock(this: That, params: T.InferencePutAmazonbedrockRequest, options?: TransportRequestOptions): Promise<T.InferencePutAmazonbedrockResponse>;
     /**
-      * Create an Anthropic inference endpoint. Create an inference endpoint to perform an inference task with the `anthropic` 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.
+      * Create an Anthropic inference endpoint. Create an inference endpoint to perform an inference task with the `anthropic` service.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-anthropic | Elasticsearch API documentation}
       */
     putAnthropic(this: That, params: T.InferencePutAnthropicRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutAnthropicResponse>;
     putAnthropic(this: That, params: T.InferencePutAnthropicRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutAnthropicResponse, unknown>>;
     putAnthropic(this: That, params: T.InferencePutAnthropicRequest, options?: TransportRequestOptions): Promise<T.InferencePutAnthropicResponse>;
     /**
-      * Create an Azure AI studio inference endpoint. Create an inference endpoint to perform an inference task with the `azureaistudio` 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.
+      * Create an Azure AI studio inference endpoint. Create an inference endpoint to perform an inference task with the `azureaistudio` service.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureaistudio | Elasticsearch API documentation}
       */
     putAzureaistudio(this: That, params: T.InferencePutAzureaistudioRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutAzureaistudioResponse>;
     putAzureaistudio(this: That, params: T.InferencePutAzureaistudioRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutAzureaistudioResponse, unknown>>;
     putAzureaistudio(this: That, params: T.InferencePutAzureaistudioRequest, options?: TransportRequestOptions): Promise<T.InferencePutAzureaistudioResponse>;
     /**
-      * Create an Azure OpenAI inference endpoint. Create an inference endpoint to perform an inference task with the `azureopenai` service. The list of chat completion models that you can choose from in your Azure OpenAI deployment include: * [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) * [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35) The 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). 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.
+      * Create an Azure OpenAI inference endpoint. Create an inference endpoint to perform an inference task with the `azureopenai` service. The list of chat completion models that you can choose from in your Azure OpenAI deployment include: * [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) * [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35) The 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).
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureopenai | Elasticsearch API documentation}
       */
     putAzureopenai(this: That, params: T.InferencePutAzureopenaiRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutAzureopenaiResponse>;
     putAzureopenai(this: That, params: T.InferencePutAzureopenaiRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutAzureopenaiResponse, unknown>>;
     putAzureopenai(this: That, params: T.InferencePutAzureopenaiRequest, options?: TransportRequestOptions): Promise<T.InferencePutAzureopenaiResponse>;
     /**
-      * Create a Cohere inference endpoint. Create an inference endpoint to perform an inference task with the `cohere` 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.
+      * Create a Cohere inference endpoint. Create an inference endpoint to perform an inference task with the `cohere` service.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-cohere | Elasticsearch API documentation}
       */
     putCohere(this: That, params: T.InferencePutCohereRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutCohereResponse>;
@@ -115,42 +115,42 @@ export default class Inference {
     putElser(this: That, params: T.InferencePutElserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutElserResponse, unknown>>;
     putElser(this: That, params: T.InferencePutElserRequest, options?: TransportRequestOptions): Promise<T.InferencePutElserResponse>;
     /**
-      * Create an Google AI Studio inference endpoint. Create an inference endpoint to perform an inference task with the `googleaistudio` 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.
+      * Create an Google AI Studio inference endpoint. Create an inference endpoint to perform an inference task with the `googleaistudio` service.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-googleaistudio | Elasticsearch API documentation}
       */
     putGoogleaistudio(this: That, params: T.InferencePutGoogleaistudioRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutGoogleaistudioResponse>;
     putGoogleaistudio(this: That, params: T.InferencePutGoogleaistudioRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutGoogleaistudioResponse, unknown>>;
     putGoogleaistudio(this: That, params: T.InferencePutGoogleaistudioRequest, options?: TransportRequestOptions): Promise<T.InferencePutGoogleaistudioResponse>;
     /**
-      * Create a Google Vertex AI inference endpoint. Create an inference endpoint to perform an inference task with the `googlevertexai` 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.
+      * Create a Google Vertex AI inference endpoint. Create an inference endpoint to perform an inference task with the `googlevertexai` service.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-googlevertexai | Elasticsearch API documentation}
       */
     putGooglevertexai(this: That, params: T.InferencePutGooglevertexaiRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutGooglevertexaiResponse>;
     putGooglevertexai(this: That, params: T.InferencePutGooglevertexaiRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutGooglevertexaiResponse, unknown>>;
     putGooglevertexai(this: That, params: T.InferencePutGooglevertexaiRequest, options?: TransportRequestOptions): Promise<T.InferencePutGooglevertexaiResponse>;
     /**
-      * Create a Hugging Face inference endpoint. Create an inference endpoint to perform an inference task with the `hugging_face` service. You must first create an inference endpoint on the Hugging Face endpoint page to get an endpoint URL. Select 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. Create the endpoint and copy the URL after the endpoint initialization has been finished. The following models are recommended for the Hugging Face service: * `all-MiniLM-L6-v2` * `all-MiniLM-L12-v2` * `all-mpnet-base-v2` * `e5-base-v2` * `e5-small-v2` * `multilingual-e5-base` * `multilingual-e5-small` 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.
+      * Create a Hugging Face inference endpoint. Create an inference endpoint to perform an inference task with the `hugging_face` service. You must first create an inference endpoint on the Hugging Face endpoint page to get an endpoint URL. Select 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. Create the endpoint and copy the URL after the endpoint initialization has been finished. The following models are recommended for the Hugging Face service: * `all-MiniLM-L6-v2` * `all-MiniLM-L12-v2` * `all-mpnet-base-v2` * `e5-base-v2` * `e5-small-v2` * `multilingual-e5-base` * `multilingual-e5-small`
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-hugging-face | Elasticsearch API documentation}
       */
     putHuggingFace(this: That, params: T.InferencePutHuggingFaceRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutHuggingFaceResponse>;
     putHuggingFace(this: That, params: T.InferencePutHuggingFaceRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutHuggingFaceResponse, unknown>>;
     putHuggingFace(this: That, params: T.InferencePutHuggingFaceRequest, options?: TransportRequestOptions): Promise<T.InferencePutHuggingFaceResponse>;
     /**
-      * Create an JinaAI inference endpoint. Create an inference endpoint to perform an inference task with the `jinaai` service. To review the available `rerank` models, refer to <https://jina.ai/reranker>. To review the available `text_embedding` models, refer to the <https://jina.ai/embeddings/>. 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.
+      * Create an JinaAI inference endpoint. Create an inference endpoint to perform an inference task with the `jinaai` service. To review the available `rerank` models, refer to <https://jina.ai/reranker>. To review the available `text_embedding` models, refer to the <https://jina.ai/embeddings/>.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-jinaai | Elasticsearch API documentation}
       */
     putJinaai(this: That, params: T.InferencePutJinaaiRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutJinaaiResponse>;
     putJinaai(this: That, params: T.InferencePutJinaaiRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutJinaaiResponse, unknown>>;
     putJinaai(this: That, params: T.InferencePutJinaaiRequest, options?: TransportRequestOptions): Promise<T.InferencePutJinaaiResponse>;
     /**
-      * Create a Mistral inference endpoint. Creates an inference endpoint to perform an inference task with the `mistral` 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.
+      * Create a Mistral inference endpoint. Creates an inference endpoint to perform an inference task with the `mistral` service.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-mistral | Elasticsearch API documentation}
       */
     putMistral(this: That, params: T.InferencePutMistralRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutMistralResponse>;
     putMistral(this: That, params: T.InferencePutMistralRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutMistralResponse, unknown>>;
     putMistral(this: That, params: T.InferencePutMistralRequest, options?: TransportRequestOptions): Promise<T.InferencePutMistralResponse>;
     /**
-      * Create an OpenAI inference endpoint. Create an inference endpoint to perform an inference task with the `openai` 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.
+      * Create an OpenAI inference endpoint. Create an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-openai | Elasticsearch API documentation}
       */
     putOpenai(this: That, params: T.InferencePutOpenaiRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutOpenaiResponse>;
@@ -164,7 +164,7 @@ export default class Inference {
     putVoyageai(this: That, params: T.InferencePutVoyageaiRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutVoyageaiResponse, unknown>>;
     putVoyageai(this: That, params: T.InferencePutVoyageaiRequest, options?: TransportRequestOptions): Promise<T.InferencePutVoyageaiResponse>;
     /**
-      * Create a Watsonx inference endpoint. Create an inference endpoint to perform an inference task with the `watsonxai` service. You need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service. You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform. 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.
+      * Create a Watsonx inference endpoint. Create an inference endpoint to perform an inference task with the `watsonxai` service. You need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service. You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-watsonx | Elasticsearch API documentation}
       */
     putWatsonx(this: That, params: T.InferencePutWatsonxRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutWatsonxResponse>;

package/lib/api/api/ml.d.ts

@@ -185,14 +185,14 @@ export default class Ml {
     getDataFrameAnalytics(this: That, params?: T.MlGetDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetDataFrameAnalyticsResponse, unknown>>;
     getDataFrameAnalytics(this: That, params?: T.MlGetDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise<T.MlGetDataFrameAnalyticsResponse>;
     /**
-      * Get data frame analytics jobs usage info.
+      * Get data frame analytics job stats.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics-stats | Elasticsearch API documentation}
       */
     getDataFrameAnalyticsStats(this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetDataFrameAnalyticsStatsResponse>;
     getDataFrameAnalyticsStats(this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetDataFrameAnalyticsStatsResponse, unknown>>;
     getDataFrameAnalyticsStats(this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptions): Promise<T.MlGetDataFrameAnalyticsStatsResponse>;
     /**
-      * Get datafeeds usage info. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds.
+      * Get datafeed stats. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-datafeed-stats | Elasticsearch API documentation}
       */
     getDatafeedStats(this: That, params?: T.MlGetDatafeedStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetDatafeedStatsResponse>;
@@ -220,7 +220,7 @@ export default class Ml {
     getInfluencers(this: That, params: T.MlGetInfluencersRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetInfluencersResponse, unknown>>;
     getInfluencers(this: That, params: T.MlGetInfluencersRequest, options?: TransportRequestOptions): Promise<T.MlGetInfluencersResponse>;
     /**
-      * Get anomaly detection jobs usage info.
+      * Get anomaly detection job stats.
       * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-job-stats | Elasticsearch API documentation}
       */
     getJobStats(this: That, params?: T.MlGetJobStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetJobStatsResponse>;

package/lib/api/types.d.ts

@@ -2639,8 +2639,8 @@ export interface SearchRequest extends RequestBase {
       * * `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method.
       * * `_only_nodes:<node-id>,<node-id>` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method.
       * * `_prefer_nodes:<node-id>,<node-id>` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method.
-      * `_shards:<shard>,<shard>` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`.
-      * `<custom-string>` (any string that does not start with `_`) to route searches with the same `<custom-string>` to the same shards in the same order. */
+      * * `_shards:<shard>,<shard>` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`.
+      * * `<custom-string>` (any string that does not start with `_`) to route searches with the same `<custom-string>` to the same shards in the same order. */
     preference?: string;
     /** 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 (if date filters are mandatory to match but the shard bounds and the query are disjoint).
@@ -3320,7 +3320,7 @@ export interface SearchInnerHits {
     ignore_unmapped?: boolean;
     script_fields?: Record<Field, ScriptField>;
     seq_no_primary_term?: boolean;
-    fields?: Fields;
+    fields?: Field[];
     /** How the inner hits should be sorted per `inner_hits`.
       * By default, inner hits are sorted by score. */
     sort?: Sort;
@@ -7160,12 +7160,18 @@ export interface AggregationsWeightedAverageValue {
 export interface AggregationsWeightedAvgAggregate extends AggregationsSingleMetricAggregateBase {
 }
 export type AnalysisAnalyzer = AnalysisCustomAnalyzer | AnalysisFingerprintAnalyzer | AnalysisKeywordAnalyzer | AnalysisNoriAnalyzer | AnalysisPatternAnalyzer | AnalysisSimpleAnalyzer | AnalysisStandardAnalyzer | AnalysisStopAnalyzer | AnalysisWhitespaceAnalyzer | AnalysisIcuAnalyzer | AnalysisKuromojiAnalyzer | AnalysisSnowballAnalyzer | AnalysisArabicAnalyzer | AnalysisArmenianAnalyzer | AnalysisBasqueAnalyzer | AnalysisBengaliAnalyzer | AnalysisBrazilianAnalyzer | AnalysisBulgarianAnalyzer | AnalysisCatalanAnalyzer | AnalysisChineseAnalyzer | AnalysisCjkAnalyzer | AnalysisCzechAnalyzer | AnalysisDanishAnalyzer | AnalysisDutchAnalyzer | AnalysisEnglishAnalyzer | AnalysisEstonianAnalyzer | AnalysisFinnishAnalyzer | AnalysisFrenchAnalyzer | AnalysisGalicianAnalyzer | AnalysisGermanAnalyzer | AnalysisGreekAnalyzer | AnalysisHindiAnalyzer | AnalysisHungarianAnalyzer | AnalysisIndonesianAnalyzer | AnalysisIrishAnalyzer | AnalysisItalianAnalyzer | AnalysisLatvianAnalyzer | AnalysisLithuanianAnalyzer | AnalysisNorwegianAnalyzer | AnalysisPersianAnalyzer | AnalysisPortugueseAnalyzer | AnalysisRomanianAnalyzer | AnalysisRussianAnalyzer | AnalysisSerbianAnalyzer | AnalysisSoraniAnalyzer | AnalysisSpanishAnalyzer | AnalysisSwedishAnalyzer | AnalysisTurkishAnalyzer | AnalysisThaiAnalyzer;
+export interface AnalysisApostropheTokenFilter extends AnalysisTokenFilterBase {
+    type: 'apostrophe';
+}
 export interface AnalysisArabicAnalyzer {
     type: 'arabic';
     stopwords?: AnalysisStopWords;
     stopwords_path?: string;
     stem_exclusion?: string[];
 }
+export interface AnalysisArabicNormalizationTokenFilter extends AnalysisTokenFilterBase {
+    type: 'arabic_normalization';
+}
 export interface AnalysisArmenianAnalyzer {
     type: 'armenian';
     stopwords?: AnalysisStopWords;
@@ -7174,6 +7180,7 @@ export interface AnalysisArmenianAnalyzer {
 }
 export interface AnalysisAsciiFoldingTokenFilter extends AnalysisTokenFilterBase {
     type: 'asciifolding';
+    /** If `true`, emit both original tokens and folded tokens. Defaults to `false`. */
     preserve_original?: SpecUtilsStringified<boolean>;
 }
 export interface AnalysisBasqueAnalyzer {
@@ -7225,29 +7232,63 @@ export interface AnalysisCjkAnalyzer {
     stopwords?: AnalysisStopWords;
     stopwords_path?: string;
 }
+export type AnalysisCjkBigramIgnoredScript = 'han' | 'hangul' | 'hiragana' | 'katakana';
+export interface AnalysisCjkBigramTokenFilter extends AnalysisTokenFilterBase {
+    type: 'cjk_bigram';
+    /** Array of character scripts for which to disable bigrams. */
+    ignored_scripts?: AnalysisCjkBigramIgnoredScript[];
+    /** If `true`, emit tokens in both bigram and unigram form. If `false`, a CJK character is output in unigram form when it has no adjacent characters. Defaults to `false`. */
+    output_unigrams?: boolean;
+}
+export interface AnalysisCjkWidthTokenFilter extends AnalysisTokenFilterBase {
+    type: 'cjk_width';
+}
+export interface AnalysisClassicTokenFilter extends AnalysisTokenFilterBase {
+    type: 'classic';
+}
 export interface AnalysisClassicTokenizer extends AnalysisTokenizerBase {
     type: 'classic';
     max_token_length?: integer;
 }
 export interface AnalysisCommonGramsTokenFilter extends AnalysisTokenFilterBase {
     type: 'common_grams';
+    /** A list of tokens. The filter generates bigrams for these tokens.
+      * Either this or the `common_words_path` parameter is required. */
     common_words?: string[];
+    /** Path to a file containing a list of tokens. The filter generates bigrams for these tokens.
+      * This path must be absolute or relative to the `config` location. The file must be UTF-8 encoded. Each token in the file must be separated by a line break.
+      * Either this or the `common_words` parameter is required. */
     common_words_path?: string;
+    /** If `true`, matches for common words matching are case-insensitive. Defaults to `false`. */
     ignore_case?: boolean;
+    /** If `true`, the filter excludes the following tokens from the output:
+      * - Unigrams for common words
+      * - Unigrams for terms followed by common words
+      * Defaults to `false`. We recommend enabling this parameter for search analyzers. */
     query_mode?: boolean;
 }
 export interface AnalysisCompoundWordTokenFilterBase extends AnalysisTokenFilterBase {
-    hyphenation_patterns_path?: string;
+    /** Maximum subword character length. Longer subword tokens are excluded from the output. Defaults to `15`. */
     max_subword_size?: integer;
+    /** Minimum subword character length. Shorter subword tokens are excluded from the output. Defaults to `2`. */
     min_subword_size?: integer;
+    /** Minimum word character length. Shorter word tokens are excluded from the output. Defaults to `5`. */
     min_word_size?: integer;
+    /** If `true`, only include the longest matching subword. Defaults to `false`. */
     only_longest_match?: boolean;
+    /** A list of subwords to look for in the token stream. If found, the subword is included in the token output.
+      * Either this parameter or `word_list_path` must be specified. */
     word_list?: string[];
+    /** Path to a file that contains a list of subwords to find in the token stream. If found, the subword is included in the token output.
+      * This path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break.
+      * Either this parameter or `word_list` must be specified. */
     word_list_path?: string;
 }
 export interface AnalysisConditionTokenFilter extends AnalysisTokenFilterBase {
     type: 'condition';
+    /** Array of token filters. If a token matches the predicate script in the `script` parameter, these filters are applied to the token in the order provided. */
     filter: string[];
+    /** Predicate script used to apply token filters. If a token matches this script, the filters in the `filter` parameter are applied to the token. */
     script: Script | ScriptSource;
 }
 export interface AnalysisCustomAnalyzer {
@@ -7274,10 +7315,15 @@ export interface AnalysisDanishAnalyzer {
     stopwords?: AnalysisStopWords;
     stopwords_path?: string;
 }
+export interface AnalysisDecimalDigitTokenFilter extends AnalysisTokenFilterBase {
+    type: 'decimal_digit';
+}
 export type AnalysisDelimitedPayloadEncoding = 'int' | 'float' | 'identity';
 export interface AnalysisDelimitedPayloadTokenFilter extends AnalysisTokenFilterBase {
     type: 'delimited_payload';
+    /** Character used to separate tokens from payloads. Defaults to `|`. */
     delimiter?: string;
+    /** Data type for the stored payload. */
     encoding?: AnalysisDelimitedPayloadEncoding;
 }
 export interface AnalysisDictionaryDecompounderTokenFilter extends AnalysisCompoundWordTokenFilterBase {
@@ -7292,9 +7338,13 @@ export interface AnalysisDutchAnalyzer {
 export type AnalysisEdgeNGramSide = 'front' | 'back';
 export interface AnalysisEdgeNGramTokenFilter extends AnalysisTokenFilterBase {
     type: 'edge_ngram';
+    /** Maximum character length of a gram. For custom token filters, defaults to `2`. For the built-in edge_ngram filter, defaults to `1`. */
     max_gram?: integer;
+    /** Minimum character length of a gram. Defaults to `1`. */
     min_gram?: integer;
+    /** Indicates whether to truncate tokens from the `front` or `back`. Defaults to `front`. */
     side?: AnalysisEdgeNGramSide;
+    /** Emits original token when set to `true`. Defaults to `false`. */
     preserve_original?: SpecUtilsStringified<boolean>;
 }
 export interface AnalysisEdgeNGramTokenizer extends AnalysisTokenizerBase {
@@ -7306,8 +7356,16 @@ export interface AnalysisEdgeNGramTokenizer extends AnalysisTokenizerBase {
 }
 export interface AnalysisElisionTokenFilter extends AnalysisTokenFilterBase {
     type: 'elision';
+    /** List of elisions to remove.
+      * To be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed.
+      * For custom `elision` filters, either this parameter or `articles_path` must be specified. */
     articles?: string[];
+    /** Path to a file that contains a list of elisions to remove.
+      * This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each elision in the file must be separated by a line break.
+      * To be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed.
+      * For custom `elision` filters, either this parameter or `articles` must be specified. */
     articles_path?: string;
+    /** If `true`, elision matching is case insensitive. If `false`, elision matching is case sensitive. Defaults to `false`. */
     articles_case?: SpecUtilsStringified<boolean>;
 }
 export interface AnalysisEnglishAnalyzer {
@@ -7338,7 +7396,9 @@ export interface AnalysisFingerprintAnalyzer {
 }
 export interface AnalysisFingerprintTokenFilter extends AnalysisTokenFilterBase {
     type: 'fingerprint';
+    /** Maximum character length, including whitespace, of the output token. Defaults to `255`. Concatenated tokens longer than this will result in no token output. */
     max_output_size?: integer;
+    /** Character to use to concatenate the token stream input. Defaults to a space. */
     separator?: string;
 }
 export interface AnalysisFinnishAnalyzer {
@@ -7347,6 +7407,9 @@ export interface AnalysisFinnishAnalyzer {
     stopwords_path?: string;
     stem_exclusion?: string[];
 }
+export interface AnalysisFlattenGraphTokenFilter extends AnalysisTokenFilterBase {
+    type: 'flatten_graph';
+}
 export interface AnalysisFrenchAnalyzer {
     type: 'french';
     stopwords?: AnalysisStopWords;
@@ -7365,6 +7428,9 @@ export interface AnalysisGermanAnalyzer {
     stopwords_path?: string;
     stem_exclusion?: string[];
 }
+export interface AnalysisGermanNormalizationTokenFilter extends AnalysisTokenFilterBase {
+    type: 'german_normalization';
+}
 export interface AnalysisGreekAnalyzer {
     type: 'greek';
     stopwords?: AnalysisStopWords;
@@ -7376,6 +7442,9 @@ export interface AnalysisHindiAnalyzer {
     stopwords_path?: string;
     stem_exclusion?: string[];
 }
+export interface AnalysisHindiNormalizationTokenFilter extends AnalysisTokenFilterBase {
+    type: 'hindi_normalization';
+}
 export interface AnalysisHtmlStripCharFilter extends AnalysisCharFilterBase {
     type: 'html_strip';
     escaped_tags?: string[];
@@ -7388,13 +7457,31 @@ export interface AnalysisHungarianAnalyzer {
 }
 export interface AnalysisHunspellTokenFilter extends AnalysisTokenFilterBase {
     type: 'hunspell';
+    /** If `true`, duplicate tokens are removed from the filter’s output. Defaults to `true`. */
     dedup?: boolean;
+    /** One or more `.dic` files (e.g, `en_US.dic`, my_custom.dic) to use for the Hunspell dictionary.
+      * By default, the `hunspell` filter uses all `.dic` files in the `<$ES_PATH_CONF>/hunspell/<locale>` directory specified using the `lang`, `language`, or `locale` parameter. */
     dictionary?: string;
+    /** Locale directory used to specify the `.aff` and `.dic` files for a Hunspell dictionary. */
     locale: string;
+    /** Locale directory used to specify the `.aff` and `.dic` files for a Hunspell dictionary.
+      * @alias locale */
+    lang: string;
+    /** Locale directory used to specify the `.aff` and `.dic` files for a Hunspell dictionary.
+      * @alias locale */
+    language: string;
+    /** If `true`, only the longest stemmed version of each token is included in the output. If `false`, all stemmed versions of the token are included. Defaults to `false`. */
     longest_only?: boolean;
 }
 export interface AnalysisHyphenationDecompounderTokenFilter extends AnalysisCompoundWordTokenFilterBase {
     type: 'hyphenation_decompounder';
+    /** Path to an Apache FOP (Formatting Objects Processor) XML hyphenation pattern file.
+      * This path must be absolute or relative to the `config` location. Only FOP v1.2 compatible files are supported. */
+    hyphenation_patterns_path: string;
+    /** If `true`, do not match sub tokens in tokens that are in the word list. Defaults to `false`. */
+    no_sub_matches?: boolean;
+    /** If `true`, do not allow overlapping tokens. Defaults to `false`. */
+    no_overlapping_matches?: boolean;
 }
 export interface AnalysisIcuAnalyzer {
     type: 'icu_analyzer';
@@ -7428,6 +7515,7 @@ export interface AnalysisIcuNormalizationCharFilter extends AnalysisCharFilterBa
     type: 'icu_normalizer';
     mode?: AnalysisIcuNormalizationMode;
     name?: AnalysisIcuNormalizationType;
+    unicode_set_filter?: string;
 }
 export type AnalysisIcuNormalizationMode = 'decompose' | 'compose';
 export interface AnalysisIcuNormalizationTokenFilter extends AnalysisTokenFilterBase {
@@ -7445,6 +7533,9 @@ export interface AnalysisIcuTransformTokenFilter extends AnalysisTokenFilterBase
     dir?: AnalysisIcuTransformDirection;
     id: string;
 }
+export interface AnalysisIndicNormalizationTokenFilter extends AnalysisTokenFilterBase {
+    type: 'indic_normalization';
+}
 export interface AnalysisIndonesianAnalyzer {
     type: 'indonesian';
     stopwords?: AnalysisStopWords;
@@ -7463,19 +7554,31 @@ export interface AnalysisItalianAnalyzer {
     stopwords_path?: string;
     stem_exclusion?: string[];
 }
+export interface AnalysisJaStopTokenFilter extends AnalysisTokenFilterBase {
+    type: 'ja_stop';
+    stopwords?: AnalysisStopWords;
+}
 export interface AnalysisKStemTokenFilter extends AnalysisTokenFilterBase {
     type: 'kstem';
 }
 export type AnalysisKeepTypesMode = 'include' | 'exclude';
 export interface AnalysisKeepTypesTokenFilter extends AnalysisTokenFilterBase {
     type: 'keep_types';
+    /** Indicates whether to keep or remove the specified token types. */
     mode?: AnalysisKeepTypesMode;
-    types?: string[];
+    /** List of token types to keep or remove. */
+    types: string[];
 }
 export interface AnalysisKeepWordsTokenFilter extends AnalysisTokenFilterBase {
     type: 'keep';
+    /** List of words to keep. Only tokens that match words in this list are included in the output.
+      * Either this parameter or `keep_words_path` must be specified. */
     keep_words?: string[];
+    /** If `true`, lowercase all keep words. Defaults to `false`. */
     keep_words_case?: boolean;
+    /** Path to a file that contains a list of words to keep. Only tokens that match words in this list are included in the output.
+      * This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break.
+      * Either this parameter or `keep_words` must be specified. */
     keep_words_path?: string;
 }
 export interface AnalysisKeywordAnalyzer {
@@ -7484,11 +7587,22 @@ export interface AnalysisKeywordAnalyzer {
 }
 export interface AnalysisKeywordMarkerTokenFilter extends AnalysisTokenFilterBase {
     type: 'keyword_marker';
+    /** If `true`, matching for the `keywords` and `keywords_path` parameters ignores letter case. Defaults to `false`. */
     ignore_case?: boolean;
+    /** Array of keywords. Tokens that match these keywords are not stemmed.
+      * This parameter, `keywords_path`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`. */
     keywords?: string | string[];
+    /** Path to a file that contains a list of keywords. Tokens that match these keywords are not stemmed.
+      * This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break.
+      * This parameter, `keywords`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`. */
     keywords_path?: string;
+    /** Java regular expression used to match tokens. Tokens that match this expression are marked as keywords and not stemmed.
+      * This parameter, `keywords`, or `keywords_path` must be specified. You cannot specify this parameter and `keywords` or `keywords_pattern`. */
     keywords_pattern?: string;
 }
+export interface AnalysisKeywordRepeatTokenFilter extends AnalysisTokenFilterBase {
+    type: 'keyword_repeat';
+}
 export interface AnalysisKeywordTokenizer extends AnalysisTokenizerBase {
     type: 'keyword';
     buffer_size?: integer;
@@ -7534,7 +7648,9 @@ export interface AnalysisLatvianAnalyzer {
 }
 export interface AnalysisLengthTokenFilter extends AnalysisTokenFilterBase {
     type: 'length';
+    /** Maximum character length of a token. Longer tokens are excluded from the output. Defaults to `Integer.MAX_VALUE`, which is `2^31-1` or `2147483647`. */
     max?: integer;
+    /** Minimum character length of a token. Shorter tokens are excluded from the output. Defaults to `0`. */
     min?: integer;
 }
 export interface AnalysisLetterTokenizer extends AnalysisTokenizerBase {
@@ -7542,7 +7658,9 @@ export interface AnalysisLetterTokenizer extends AnalysisTokenizerBase {
 }
 export interface AnalysisLimitTokenCountTokenFilter extends AnalysisTokenFilterBase {
     type: 'limit';
+    /** If `true`, the limit filter exhausts the token stream, even if the `max_token_count` has already been reached. Defaults to `false`. */
     consume_all_tokens?: boolean;
+    /** Maximum number of tokens to keep. Once this limit is reached, any remaining tokens are excluded from the output. Defaults to `1`. */
     max_token_count?: SpecUtilsStringified<integer>;
 }
 export interface AnalysisLithuanianAnalyzer {
@@ -7556,8 +7674,10 @@ export interface AnalysisLowercaseNormalizer {
 }
 export interface AnalysisLowercaseTokenFilter extends AnalysisTokenFilterBase {
     type: 'lowercase';
-    language?: string;
+    /** Language-specific lowercase token filter to use. */
+    language?: AnalysisLowercaseTokenFilterLanguages;
 }
+export type AnalysisLowercaseTokenFilterLanguages = 'greek' | 'irish' | 'turkish';
 export interface AnalysisLowercaseTokenizer extends AnalysisTokenizerBase {
     type: 'lowercase';
 }
@@ -7566,15 +7686,32 @@ export interface AnalysisMappingCharFilter extends AnalysisCharFilterBase {
     mappings?: string[];
     mappings_path?: string;
 }
+export interface AnalysisMinHashTokenFilter extends AnalysisTokenFilterBase {
+    type: 'min_hash';
+    /** Number of buckets to which hashes are assigned. Defaults to `512`. */
+    bucket_count?: integer;
+    /** Number of ways to hash each token in the stream. Defaults to `1`. */
+    hash_count?: integer;
+    /** Number of hashes to keep from each bucket. Defaults to `1`.
+      * Hashes are retained by ascending size, starting with the bucket’s smallest hash first. */
+    hash_set_size?: integer;
+    /** If `true`, the filter fills empty buckets with the value of the first non-empty bucket to its circular right if the `hash_set_size` is `1`. If the `bucket_count` argument is greater than 1, this parameter defaults to `true`. Otherwise, this parameter defaults to `false`. */
+    with_rotation?: boolean;
+}
 export interface AnalysisMultiplexerTokenFilter extends AnalysisTokenFilterBase {
     type: 'multiplexer';
+    /** A list of token filters to apply to incoming tokens. */
     filters: string[];
+    /** If `true` (the default) then emit the original token in addition to the filtered tokens. */
     preserve_original?: SpecUtilsStringified<boolean>;
 }
 export interface AnalysisNGramTokenFilter extends AnalysisTokenFilterBase {
     type: 'ngram';
+    /** Maximum length of characters in a gram. Defaults to `2`. */
     max_gram?: integer;
+    /** Minimum length of characters in a gram. Defaults to `1`. */
     min_gram?: integer;
+    /** Emits original token when set to `true`. Defaults to `false`. */
     preserve_original?: SpecUtilsStringified<boolean>;
 }
 export interface AnalysisNGramTokenizer extends AnalysisTokenizerBase {
@@ -7594,6 +7731,7 @@ export interface AnalysisNoriAnalyzer {
 export type AnalysisNoriDecompoundMode = 'discard' | 'none' | 'mixed';
 export interface AnalysisNoriPartOfSpeechTokenFilter extends AnalysisTokenFilterBase {
     type: 'nori_part_of_speech';
+    /** An array of part-of-speech tags that should be removed. */
     stoptags?: string[];
 }
 export interface AnalysisNoriTokenizer extends AnalysisTokenizerBase {
@@ -7637,7 +7775,9 @@ export interface AnalysisPatternAnalyzer {
 }
 export interface AnalysisPatternCaptureTokenFilter extends AnalysisTokenFilterBase {
     type: 'pattern_capture';
+    /** A list of regular expressions to match. */
     patterns: string[];
+    /** If set to `true` (the default) it will emit the original token. */
     preserve_original?: SpecUtilsStringified<boolean>;
 }
 export interface AnalysisPatternReplaceCharFilter extends AnalysisCharFilterBase {
@@ -7648,9 +7788,11 @@ export interface AnalysisPatternReplaceCharFilter extends AnalysisCharFilterBase
 }
 export interface AnalysisPatternReplaceTokenFilter extends AnalysisTokenFilterBase {
     type: 'pattern_replace';
+    /** If `true`, all substrings matching the pattern parameter’s regular expression are replaced. If `false`, the filter replaces only the first matching substring in each token. Defaults to `true`. */
     all?: boolean;
-    flags?: string;
+    /** Regular expression, written in Java’s regular expression syntax. The filter replaces token substrings matching this pattern with the substring in the `replacement` parameter. */
     pattern: string;
+    /** Replacement substring. Defaults to an empty substring (`""`). */
     replacement?: string;
 }
 export interface AnalysisPatternTokenizer extends AnalysisTokenizerBase {
@@ -7664,6 +7806,9 @@ export interface AnalysisPersianAnalyzer {
     stopwords?: AnalysisStopWords;
     stopwords_path?: string;
 }
+export interface AnalysisPersianNormalizationTokenFilter extends AnalysisTokenFilterBase {
+    type: 'persian_normalization';
+}
 export type AnalysisPhoneticEncoder = 'metaphone' | 'double_metaphone' | 'soundex' | 'refined_soundex' | 'caverphone1' | 'caverphone2' | 'cologne' | 'nysiis' | 'koelnerphonetik' | 'haasephonetik' | 'beider_morse' | 'daitch_mokotoff';
 export type AnalysisPhoneticLanguage = 'any' | 'common' | 'cyrillic' | 'english' | 'french' | 'german' | 'hebrew' | 'hungarian' | 'polish' | 'romanian' | 'russian' | 'spanish';
 export type AnalysisPhoneticNameType = 'generic' | 'ashkenazi' | 'sephardic';
@@ -7688,6 +7833,7 @@ export interface AnalysisPortugueseAnalyzer {
 }
 export interface AnalysisPredicateTokenFilter extends AnalysisTokenFilterBase {
     type: 'predicate_token_filter';
+    /** Script containing a condition used to filter incoming tokens. Only tokens that match this script are included in the output. */
     script: Script | ScriptSource;
 }
 export interface AnalysisRemoveDuplicatesTokenFilter extends AnalysisTokenFilterBase {
@@ -7708,19 +7854,34 @@ export interface AnalysisRussianAnalyzer {
     stopwords_path?: string;
     stem_exclusion?: string[];
 }
+export interface AnalysisScandinavianFoldingTokenFilter extends AnalysisTokenFilterBase {
+    type: 'scandinavian_folding';
+}
+export interface AnalysisScandinavianNormalizationTokenFilter extends AnalysisTokenFilterBase {
+    type: 'scandinavian_normalization';
+}
 export interface AnalysisSerbianAnalyzer {
     type: 'serbian';
     stopwords?: AnalysisStopWords;
     stopwords_path?: string;
     stem_exclusion?: string[];
 }
+export interface AnalysisSerbianNormalizationTokenFilter extends AnalysisTokenFilterBase {
+    type: 'serbian_normalization';
+}
 export interface AnalysisShingleTokenFilter extends AnalysisTokenFilterBase {
     type: 'shingle';
+    /** String used in shingles as a replacement for empty positions that do not contain a token. This filler token is only used in shingles, not original unigrams. Defaults to an underscore (`_`). */
     filler_token?: string;
-    max_shingle_size?: integer | string;
-    min_shingle_size?: integer | string;
+    /** Maximum number of tokens to concatenate when creating shingles. Defaults to `2`. */
+    max_shingle_size?: SpecUtilsStringified<integer>;
+    /** Minimum number of tokens to concatenate when creating shingles. Defaults to `2`. */
+    min_shingle_size?: SpecUtilsStringified<integer>;
+    /** If `true`, the output includes the original input tokens. If `false`, the output only includes shingles; the original input tokens are removed. Defaults to `true`. */
     output_unigrams?: boolean;
+    /** If `true`, the output includes the original input tokens only if no shingles are produced; if shingles are produced, the output only includes shingles. Defaults to `false`. */
     output_unigrams_if_no_shingles?: boolean;
+    /** Separator used to concatenate adjacent tokens to form a shingle. Defaults to a space (`" "`). */
     token_separator?: string;
 }
 export interface AnalysisSimpleAnalyzer {
@@ -7741,9 +7902,10 @@ export interface AnalysisSnowballAnalyzer {
     language: AnalysisSnowballLanguage;
     stopwords?: AnalysisStopWords;
 }
-export type AnalysisSnowballLanguage = 'Armenian' | 'Basque' | 'Catalan' | 'Danish' | 'Dutch' | 'English' | 'Finnish' | 'French' | 'German' | 'German2' | 'Hungarian' | 'Italian' | 'Kp' | 'Lovins' | 'Norwegian' | 'Porter' | 'Portuguese' | 'Romanian' | 'Russian' | 'Spanish' | 'Swedish' | 'Turkish';
+export type AnalysisSnowballLanguage = 'Arabic' | 'Armenian' | 'Basque' | 'Catalan' | 'Danish' | 'Dutch' | 'English' | 'Estonian' | 'Finnish' | 'French' | 'German' | 'German2' | 'Hungarian' | 'Italian' | 'Irish' | 'Kp' | 'Lithuanian' | 'Lovins' | 'Norwegian' | 'Porter' | 'Portuguese' | 'Romanian' | 'Russian' | 'Serbian' | 'Spanish' | 'Swedish' | 'Turkish';
 export interface AnalysisSnowballTokenFilter extends AnalysisTokenFilterBase {
     type: 'snowball';
+    /** Controls the language used by the stemmer. */
     language?: AnalysisSnowballLanguage;
 }
 export interface AnalysisSoraniAnalyzer {
@@ -7752,6 +7914,9 @@ export interface AnalysisSoraniAnalyzer {
     stopwords_path?: string;
     stem_exclusion?: string[];
 }
+export interface AnalysisSoraniNormalizationTokenFilter extends AnalysisTokenFilterBase {
+    type: 'sorani_normalization';
+}
 export interface AnalysisSpanishAnalyzer {
     type: 'spanish';
     stopwords?: AnalysisStopWords;
@@ -7775,7 +7940,9 @@ export interface AnalysisStandardTokenizer extends AnalysisTokenizerBase {
 }
 export interface AnalysisStemmerOverrideTokenFilter extends AnalysisTokenFilterBase {
     type: 'stemmer_override';
+    /** A list of mapping rules to use. */
     rules?: string[];
+    /** A path (either relative to `config` location, or absolute) to a list of mappings. */
     rules_path?: string;
 }
 export interface AnalysisStemmerTokenFilter extends AnalysisTokenFilterBase {
@@ -7795,12 +7962,18 @@ export interface AnalysisStopAnalyzer {
 }
 export interface AnalysisStopTokenFilter extends AnalysisTokenFilterBase {
     type: 'stop';
+    /** If `true`, stop word matching is case insensitive. For example, if `true`, a stop word of the matches and removes `The`, `THE`, or `the`. Defaults to `false`. */
     ignore_case?: boolean;
+    /** If `true`, the last token of a stream is removed if it’s a stop word. Defaults to `true`. */
     remove_trailing?: boolean;
+    /** Language value, such as `_arabic_` or `_thai_`. Defaults to `_english_`. */
     stopwords?: AnalysisStopWords;
+    /** Path to a file that contains a list of stop words to remove.
+      * This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each stop word in the file must be separated by a line break. */
     stopwords_path?: string;
 }
-export type AnalysisStopWords = string | string[];
+export type AnalysisStopWordLanguage = '_arabic_' | '_armenian_' | '_basque_' | '_bengali_' | '_brazilian_' | '_bulgarian_' | '_catalan_' | '_cjk_' | '_czech_' | '_danish_' | '_dutch_' | '_english_' | '_estonian_' | '_finnish_' | '_french_' | '_galician_' | '_german_' | '_greek_' | '_hindi_' | '_hungarian_' | '_indonesian_' | '_irish_' | '_italian_' | '_latvian_' | '_lithuanian_' | '_norwegian_' | '_persian_' | '_portuguese_' | '_romanian_' | '_russian_' | '_serbian_' | '_sorani_' | '_spanish_' | '_swedish_' | '_thai_' | '_turkish_' | '_none_';
+export type AnalysisStopWords = AnalysisStopWordLanguage | string[];
 export interface AnalysisSwedishAnalyzer {
     type: 'swedish';
     stopwords?: AnalysisStopWords;
@@ -7808,26 +7981,28 @@ export interface AnalysisSwedishAnalyzer {
     stem_exclusion?: string[];
 }
 export type AnalysisSynonymFormat = 'solr' | 'wordnet';
-export interface AnalysisSynonymGraphTokenFilter extends AnalysisTokenFilterBase {
+export interface AnalysisSynonymGraphTokenFilter extends AnalysisSynonymTokenFilterBase {
     type: 'synonym_graph';
-    expand?: boolean;
-    format?: AnalysisSynonymFormat;
-    lenient?: boolean;
-    synonyms?: string[];
-    synonyms_path?: string;
-    synonyms_set?: string;
-    tokenizer?: string;
-    updateable?: boolean;
 }
-export interface AnalysisSynonymTokenFilter extends AnalysisTokenFilterBase {
+export interface AnalysisSynonymTokenFilter extends AnalysisSynonymTokenFilterBase {
     type: 'synonym';
+}
+export interface AnalysisSynonymTokenFilterBase extends AnalysisTokenFilterBase {
+    /** Expands definitions for equivalent synonym rules. Defaults to `true`. */
     expand?: boolean;
+    /** Sets the synonym rules format. */
     format?: AnalysisSynonymFormat;
+    /** If `true` ignores errors while parsing the synonym rules. It is important to note that only those synonym rules which cannot get parsed are ignored. Defaults to the value of the `updateable` setting. */
     lenient?: boolean;
+    /** Used to define inline synonyms. */
     synonyms?: string[];
+    /** Used to provide a synonym file. This path must be absolute or relative to the `config` location. */
     synonyms_path?: string;
+    /** Provide a synonym set created via Synonyms Management APIs. */
     synonyms_set?: string;
+    /** Controls the tokenizers that will be used to tokenize the synonym, this parameter is for backwards compatibility for indices that created before 6.0. */
     tokenizer?: string;
+    /** If `true` allows reloading search analyzers to pick up changes to synonym files. Only to be used for search analyzers. Defaults to `false`. */
     updateable?: boolean;
 }
 export interface AnalysisThaiAnalyzer {
@@ -7843,7 +8018,7 @@ export type AnalysisTokenFilter = string | AnalysisTokenFilterDefinition;
 export interface AnalysisTokenFilterBase {
     version?: VersionString;
 }
-export type AnalysisTokenFilterDefinition = AnalysisAsciiFoldingTokenFilter | AnalysisCommonGramsTokenFilter | AnalysisConditionTokenFilter | AnalysisDelimitedPayloadTokenFilter | AnalysisEdgeNGramTokenFilter | AnalysisElisionTokenFilter | AnalysisFingerprintTokenFilter | AnalysisHunspellTokenFilter | AnalysisHyphenationDecompounderTokenFilter | AnalysisKeepTypesTokenFilter | AnalysisKeepWordsTokenFilter | AnalysisKeywordMarkerTokenFilter | AnalysisKStemTokenFilter | AnalysisLengthTokenFilter | AnalysisLimitTokenCountTokenFilter | AnalysisLowercaseTokenFilter | AnalysisMultiplexerTokenFilter | AnalysisNGramTokenFilter | AnalysisNoriPartOfSpeechTokenFilter | AnalysisPatternCaptureTokenFilter | AnalysisPatternReplaceTokenFilter | AnalysisPorterStemTokenFilter | AnalysisPredicateTokenFilter | AnalysisRemoveDuplicatesTokenFilter | AnalysisReverseTokenFilter | AnalysisShingleTokenFilter | AnalysisSnowballTokenFilter | AnalysisStemmerOverrideTokenFilter | AnalysisStemmerTokenFilter | AnalysisStopTokenFilter | AnalysisSynonymGraphTokenFilter | AnalysisSynonymTokenFilter | AnalysisTrimTokenFilter | AnalysisTruncateTokenFilter | AnalysisUniqueTokenFilter | AnalysisUppercaseTokenFilter | AnalysisWordDelimiterGraphTokenFilter | AnalysisWordDelimiterTokenFilter | AnalysisKuromojiStemmerTokenFilter | AnalysisKuromojiReadingFormTokenFilter | AnalysisKuromojiPartOfSpeechTokenFilter | AnalysisIcuCollationTokenFilter | AnalysisIcuFoldingTokenFilter | AnalysisIcuNormalizationTokenFilter | AnalysisIcuTransformTokenFilter | AnalysisPhoneticTokenFilter | AnalysisDictionaryDecompounderTokenFilter;
+export type AnalysisTokenFilterDefinition = AnalysisApostropheTokenFilter | AnalysisArabicNormalizationTokenFilter | AnalysisAsciiFoldingTokenFilter | AnalysisCjkBigramTokenFilter | AnalysisCjkWidthTokenFilter | AnalysisClassicTokenFilter | AnalysisCommonGramsTokenFilter | AnalysisConditionTokenFilter | AnalysisDecimalDigitTokenFilter | AnalysisDelimitedPayloadTokenFilter | AnalysisEdgeNGramTokenFilter | AnalysisElisionTokenFilter | AnalysisFingerprintTokenFilter | AnalysisFlattenGraphTokenFilter | AnalysisGermanNormalizationTokenFilter | AnalysisHindiNormalizationTokenFilter | AnalysisHunspellTokenFilter | AnalysisHyphenationDecompounderTokenFilter | AnalysisIndicNormalizationTokenFilter | AnalysisKeepTypesTokenFilter | AnalysisKeepWordsTokenFilter | AnalysisKeywordMarkerTokenFilter | AnalysisKeywordRepeatTokenFilter | AnalysisKStemTokenFilter | AnalysisLengthTokenFilter | AnalysisLimitTokenCountTokenFilter | AnalysisLowercaseTokenFilter | AnalysisMinHashTokenFilter | AnalysisMultiplexerTokenFilter | AnalysisNGramTokenFilter | AnalysisNoriPartOfSpeechTokenFilter | AnalysisPatternCaptureTokenFilter | AnalysisPatternReplaceTokenFilter | AnalysisPersianNormalizationTokenFilter | AnalysisPorterStemTokenFilter | AnalysisPredicateTokenFilter | AnalysisRemoveDuplicatesTokenFilter | AnalysisReverseTokenFilter | AnalysisScandinavianFoldingTokenFilter | AnalysisScandinavianNormalizationTokenFilter | AnalysisSerbianNormalizationTokenFilter | AnalysisShingleTokenFilter | AnalysisSnowballTokenFilter | AnalysisSoraniNormalizationTokenFilter | AnalysisStemmerOverrideTokenFilter | AnalysisStemmerTokenFilter | AnalysisStopTokenFilter | AnalysisSynonymGraphTokenFilter | AnalysisSynonymTokenFilter | AnalysisTrimTokenFilter | AnalysisTruncateTokenFilter | AnalysisUniqueTokenFilter | AnalysisUppercaseTokenFilter | AnalysisWordDelimiterGraphTokenFilter | AnalysisWordDelimiterTokenFilter | AnalysisJaStopTokenFilter | AnalysisKuromojiStemmerTokenFilter | AnalysisKuromojiReadingFormTokenFilter | AnalysisKuromojiPartOfSpeechTokenFilter | AnalysisIcuCollationTokenFilter | AnalysisIcuFoldingTokenFilter | AnalysisIcuNormalizationTokenFilter | AnalysisIcuTransformTokenFilter | AnalysisPhoneticTokenFilter | AnalysisDictionaryDecompounderTokenFilter;
 export type AnalysisTokenizer = string | AnalysisTokenizerDefinition;
 export interface AnalysisTokenizerBase {
     version?: VersionString;
@@ -7854,6 +8029,7 @@ export interface AnalysisTrimTokenFilter extends AnalysisTokenFilterBase {
 }
 export interface AnalysisTruncateTokenFilter extends AnalysisTokenFilterBase {
     type: 'truncate';
+    /** Character limit for each token. Tokens exceeding this limit are truncated. Defaults to `10`. */
     length?: integer;
 }
 export interface AnalysisTurkishAnalyzer {
@@ -7868,6 +8044,7 @@ export interface AnalysisUaxEmailUrlTokenizer extends AnalysisTokenizerBase {
 }
 export interface AnalysisUniqueTokenFilter extends AnalysisTokenFilterBase {
     type: 'unique';
+    /** If `true`, only remove duplicate tokens in the same position. Defaults to `false`. */
     only_on_same_position?: boolean;
 }
 export interface AnalysisUppercaseTokenFilter extends AnalysisTokenFilterBase {
@@ -7881,38 +8058,43 @@ export interface AnalysisWhitespaceTokenizer extends AnalysisTokenizerBase {
     type: 'whitespace';
     max_token_length?: integer;
 }
-export interface AnalysisWordDelimiterGraphTokenFilter extends AnalysisTokenFilterBase {
+export interface AnalysisWordDelimiterGraphTokenFilter extends AnalysisWordDelimiterTokenFilterBase {
     type: 'word_delimiter_graph';
+    /** If `true`, the filter adjusts the offsets of split or catenated tokens to better reflect their actual position in the token stream. Defaults to `true`. */
     adjust_offsets?: boolean;
-    catenate_all?: boolean;
-    catenate_numbers?: boolean;
-    catenate_words?: boolean;
-    generate_number_parts?: boolean;
-    generate_word_parts?: boolean;
+    /** If `true`, the filter skips tokens with a keyword attribute of true. Defaults to `false`. */
     ignore_keywords?: boolean;
-    preserve_original?: SpecUtilsStringified<boolean>;
-    protected_words?: string[];
-    protected_words_path?: string;
-    split_on_case_change?: boolean;
-    split_on_numerics?: boolean;
-    stem_english_possessive?: boolean;
-    type_table?: string[];
-    type_table_path?: string;
 }
-export interface AnalysisWordDelimiterTokenFilter extends AnalysisTokenFilterBase {
+export interface AnalysisWordDelimiterTokenFilter extends AnalysisWordDelimiterTokenFilterBase {
     type: 'word_delimiter';
+}
+export interface AnalysisWordDelimiterTokenFilterBase extends AnalysisTokenFilterBase {
+    /** If `true`, the filter produces catenated tokens for chains of alphanumeric characters separated by non-alphabetic delimiters. Defaults to `false`. */
     catenate_all?: boolean;
+    /** If `true`, the filter produces catenated tokens for chains of numeric characters separated by non-alphabetic delimiters. Defaults to `false`. */
     catenate_numbers?: boolean;
+    /** If `true`, the filter produces catenated tokens for chains of alphabetical characters separated by non-alphabetic delimiters. Defaults to `false`. */
     catenate_words?: boolean;
+    /** If `true`, the filter includes tokens consisting of only numeric characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`. */
     generate_number_parts?: boolean;
+    /** If `true`, the filter includes tokens consisting of only alphabetical characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`. */
     generate_word_parts?: boolean;
+    /** If `true`, the filter includes the original version of any split tokens in the output. This original version includes non-alphanumeric delimiters. Defaults to `false`. */
     preserve_original?: SpecUtilsStringified<boolean>;
+    /** Array of tokens the filter won’t split. */
     protected_words?: string[];
+    /** Path to a file that contains a list of tokens the filter won’t split.
+      * This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break. */
     protected_words_path?: string;
+    /** If `true`, the filter splits tokens at letter case transitions. For example: camelCase -> [ camel, Case ]. Defaults to `true`. */
     split_on_case_change?: boolean;
+    /** If `true`, the filter splits tokens at letter-number transitions. For example: j2se -> [ j, 2, se ]. Defaults to `true`. */
     split_on_numerics?: boolean;
+    /** If `true`, the filter removes the English possessive (`'s`) from the end of each token. For example: O'Neil's -> [ O, Neil ]. Defaults to `true`. */
     stem_english_possessive?: boolean;
+    /** Array of custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters. */
     type_table?: string[];
+    /** Path to a file that contains custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters. */
     type_table_path?: string;
 }
 export interface MappingAggregateMetricDoubleProperty extends MappingPropertyBase {
@@ -10208,6 +10390,8 @@ export type CatCatDatafeedColumn = 'ae' | 'assignment_explanation' | 'bc' | 'buc
 export type CatCatDatafeedColumns = CatCatDatafeedColumn | CatCatDatafeedColumn[];
 export type CatCatDfaColumn = 'assignment_explanation' | 'ae' | 'create_time' | 'ct' | 'createTime' | 'description' | 'd' | 'dest_index' | 'di' | 'destIndex' | 'failure_reason' | 'fr' | 'failureReason' | 'id' | 'model_memory_limit' | 'mml' | 'modelMemoryLimit' | 'node.address' | 'na' | 'nodeAddress' | 'node.ephemeral_id' | 'ne' | 'nodeEphemeralId' | 'node.id' | 'ni' | 'nodeId' | 'node.name' | 'nn' | 'nodeName' | 'progress' | 'p' | 'source_index' | 'si' | 'sourceIndex' | 'state' | 's' | 'type' | 't' | 'version' | 'v';
 export type CatCatDfaColumns = CatCatDfaColumn | CatCatDfaColumn[];
+export type CatCatNodeColumn = 'build' | 'b' | 'completion.size' | 'cs' | 'completionSize' | 'cpu' | 'disk.avail' | 'd' | 'disk' | 'diskAvail' | 'disk.total' | 'dt' | 'diskTotal' | 'disk.used' | 'du' | 'diskUsed' | 'disk.used_percent' | 'dup' | 'diskUsedPercent' | 'fielddata.evictions' | 'fe' | 'fielddataEvictions' | 'fielddata.memory_size' | 'fm' | 'fielddataMemory' | 'file_desc.current' | 'fdc' | 'fileDescriptorCurrent' | 'file_desc.max' | 'fdm' | 'fileDescriptorMax' | 'file_desc.percent' | 'fdp' | 'fileDescriptorPercent' | 'flush.total' | 'ft' | 'flushTotal' | 'flush.total_time' | 'ftt' | 'flushTotalTime' | 'get.current' | 'gc' | 'getCurrent' | 'get.exists_time' | 'geti' | 'getExistsTime' | 'get.exists_total' | 'geto' | 'getExistsTotal' | 'get.missing_time' | 'gmti' | 'getMissingTime' | 'get.missing_total' | 'gmto' | 'getMissingTotal' | 'get.time' | 'gti' | 'getTime' | 'get.total' | 'gto' | 'getTotal' | 'heap.current' | 'hc' | 'heapCurrent' | 'heap.max' | 'hm' | 'heapMax' | 'heap.percent' | 'hp' | 'heapPercent' | 'http_address' | 'http' | 'id' | 'nodeId' | 'indexing.delete_current' | 'idc' | 'indexingDeleteCurrent' | 'indexing.delete_time' | 'idti' | 'indexingDeleteTime' | 'indexing.delete_total' | 'idto' | 'indexingDeleteTotal' | 'indexing.index_current' | 'iic' | 'indexingIndexCurrent' | 'indexing.index_failed' | 'iif' | 'indexingIndexFailed' | 'indexing.index_failed_due_to_version_conflict' | 'iifvc' | 'indexingIndexFailedDueToVersionConflict' | 'indexing.index_time' | 'iiti' | 'indexingIndexTime' | 'indexing.index_total' | 'iito' | 'indexingIndexTotal' | 'ip' | 'i' | 'jdk' | 'j' | 'load_1m' | 'l' | 'load_5m' | 'l' | 'load_15m' | 'l' | 'mappings.total_count' | 'mtc' | 'mappingsTotalCount' | 'mappings.total_estimated_overhead_in_bytes' | 'mteo' | 'mappingsTotalEstimatedOverheadInBytes' | 'master' | 'm' | 'merges.current' | 'mc' | 'mergesCurrent' | 'merges.current_docs' | 'mcd' | 'mergesCurrentDocs' | 'merges.current_size' | 'mcs' | 'mergesCurrentSize' | 'merges.total' | 'mt' | 'mergesTotal' | 'merges.total_docs' | 'mtd' | 'mergesTotalDocs' | 'merges.total_size' | 'mts' | 'mergesTotalSize' | 'merges.total_time' | 'mtt' | 'mergesTotalTime' | 'name' | 'n' | 'node.role' | 'r' | 'role' | 'nodeRole' | 'pid' | 'p' | 'port' | 'po' | 'query_cache.memory_size' | 'qcm' | 'queryCacheMemory' | 'query_cache.evictions' | 'qce' | 'queryCacheEvictions' | 'query_cache.hit_count' | 'qchc' | 'queryCacheHitCount' | 'query_cache.miss_count' | 'qcmc' | 'queryCacheMissCount' | 'ram.current' | 'rc' | 'ramCurrent' | 'ram.max' | 'rm' | 'ramMax' | 'ram.percent' | 'rp' | 'ramPercent' | 'refresh.total' | 'rto' | 'refreshTotal' | 'refresh.time' | 'rti' | 'refreshTime' | 'request_cache.memory_size' | 'rcm' | 'requestCacheMemory' | 'request_cache.evictions' | 'rce' | 'requestCacheEvictions' | 'request_cache.hit_count' | 'rchc' | 'requestCacheHitCount' | 'request_cache.miss_count' | 'rcmc' | 'requestCacheMissCount' | 'script.compilations' | 'scrcc' | 'scriptCompilations' | 'script.cache_evictions' | 'scrce' | 'scriptCacheEvictions' | 'search.fetch_current' | 'sfc' | 'searchFetchCurrent' | 'search.fetch_time' | 'sfti' | 'searchFetchTime' | 'search.fetch_total' | 'sfto' | 'searchFetchTotal' | 'search.open_contexts' | 'so' | 'searchOpenContexts' | 'search.query_current' | 'sqc' | 'searchQueryCurrent' | 'search.query_time' | 'sqti' | 'searchQueryTime' | 'search.query_total' | 'sqto' | 'searchQueryTotal' | 'search.scroll_current' | 'scc' | 'searchScrollCurrent' | 'search.scroll_time' | 'scti' | 'searchScrollTime' | 'search.scroll_total' | 'scto' | 'searchScrollTotal' | 'segments.count' | 'sc' | 'segmentsCount' | 'segments.fixed_bitset_memory' | 'sfbm' | 'fixedBitsetMemory' | 'segments.index_writer_memory' | 'siwm' | 'segmentsIndexWriterMemory' | 'segments.memory' | 'sm' | 'segmentsMemory' | 'segments.version_map_memory' | 'svmm' | 'segmentsVersionMapMemory' | 'shard_stats.total_count' | 'sstc' | 'shards' | 'shardStatsTotalCount' | 'suggest.current' | 'suc' | 'suggestCurrent' | 'suggest.time' | 'suti' | 'suggestTime' | 'suggest.total' | 'suto' | 'suggestTotal' | 'uptime' | 'u' | 'version' | 'v' | string;
+export type CatCatNodeColumns = CatCatNodeColumn | CatCatNodeColumn[];
 export interface CatCatRequestBase extends RequestBase, SpecUtilsCommonCatQueryParameters {
 }
 export type CatCatTrainedModelsColumn = 'create_time' | 'ct' | 'created_by' | 'c' | 'createdBy' | 'data_frame_analytics_id' | 'df' | 'dataFrameAnalytics' | 'dfid' | 'description' | 'd' | 'heap_size' | 'hs' | 'modelHeapSize' | 'id' | 'ingest.count' | 'ic' | 'ingestCount' | 'ingest.current' | 'icurr' | 'ingestCurrent' | 'ingest.failed' | 'if' | 'ingestFailed' | 'ingest.pipelines' | 'ip' | 'ingestPipelines' | 'ingest.time' | 'it' | 'ingestTime' | 'license' | 'l' | 'operations' | 'o' | 'modelOperations' | 'version' | 'v';
@@ -13439,15 +13623,16 @@ export interface CatNodesRequest extends CatCatRequestBase {
     full_id?: boolean | string;
     /** If true, the response includes information from segments that are not loaded into memory. */
     include_unloaded_segments?: boolean;
-    /** List of columns to appear in the response. Supports simple wildcards. */
-    h?: Names;
-    /** List of columns that determine how the table should be sorted.
+    /** A comma-separated list of columns names to display.
+      * It supports simple wildcards. */
+    h?: CatCatNodeColumns;
+    /** A comma-separated list of column names or aliases that determines the sort order.
       * Sorting defaults to ascending and can be changed by setting `:asc`
       * or `:desc` as a suffix to the column name. */
     s?: Names;
-    /** Period to wait for a connection to the master node. */
+    /** The period to wait for a connection to the master node. */
     master_timeout?: Duration;
-    /** Unit used to display time values. */
+    /** The unit used to display time values. */
     time?: TimeUnit;
     /** All values in `body` will be added to the request body. */
     body?: string | ({
@@ -16862,6 +17047,58 @@ export interface ClusterStateRequest extends RequestBase {
     };
 }
 export type ClusterStateResponse = any;
+export interface ClusterStatsCCSStats {
+    /** Contains remote cluster settings and metrics collected from them.
+      * The keys are cluster names, and the values are per-cluster data.
+      * Only present if `include_remotes` option is set to true. */
+    clusters?: Record<string, ClusterStatsRemoteClusterInfo>;
+    /** Information about cross-cluster search usage. */
+    _search: ClusterStatsCCSUsageStats;
+    /** Information about ES|QL cross-cluster query usage. */
+    _esql?: ClusterStatsCCSUsageStats;
+}
+export interface ClusterStatsCCSUsageClusterStats {
+    /** The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely. */
+    total: integer;
+    /** The total number of cross-cluster search requests for which this cluster was skipped. */
+    skipped: integer;
+    /** Statistics about the time taken to execute requests against this cluster. */
+    took: ClusterStatsCCSUsageTimeValue;
+}
+export interface ClusterStatsCCSUsageStats {
+    /** The total number of cross-cluster search requests that have been executed by the cluster. */
+    total: integer;
+    /** The total number of cross-cluster search requests that have been successfully executed by the cluster. */
+    success: integer;
+    /** The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped. */
+    skipped: integer;
+    /** Statistics about the time taken to execute cross-cluster search requests. */
+    took: ClusterStatsCCSUsageTimeValue;
+    /** Statistics about the time taken to execute cross-cluster search requests for which the `ccs_minimize_roundtrips` setting was set to `true`. */
+    took_mrt_true?: ClusterStatsCCSUsageTimeValue;
+    /** Statistics about the time taken to execute cross-cluster search requests for which the `ccs_minimize_roundtrips` setting was set to `false`. */
+    took_mrt_false?: ClusterStatsCCSUsageTimeValue;
+    /** The maximum number of remote clusters that were queried in a single cross-cluster search request. */
+    remotes_per_search_max: integer;
+    /** The average number of remote clusters that were queried in a single cross-cluster search request. */
+    remotes_per_search_avg: double;
+    /** Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason. */
+    failure_reasons: Record<string, integer>;
+    /** The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both `async` and `wildcard`). */
+    features: Record<string, integer>;
+    /** Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as `kibana` or `elasticsearch`) are counted. */
+    clients: Record<string, integer>;
+    /** Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name `(local)`. */
+    clusters: Record<string, ClusterStatsCCSUsageClusterStats>;
+}
+export interface ClusterStatsCCSUsageTimeValue {
+    /** The maximum time taken to execute a request, in milliseconds. */
+    max: DurationValue<UnitMillis>;
+    /** The average time taken to execute a request, in milliseconds. */
+    avg: DurationValue<UnitMillis>;
+    /** The 90th percentile of the time taken to execute requests, in milliseconds. */
+    p90: DurationValue<UnitMillis>;
+}
 export interface ClusterStatsCharFilterTypes {
     /** Contains statistics about analyzer types used in selected nodes. */
     analyzer_types: ClusterStatsFieldTypes[];
@@ -17163,6 +17400,38 @@ export interface ClusterStatsOperatingSystemMemoryInfo {
     /** Percentage of physical memory in use across all selected nodes. */
     used_percent: integer;
 }
+export interface ClusterStatsRemoteClusterInfo {
+    /** The UUID of the remote cluster. */
+    cluster_uuid: string;
+    /** The connection mode used to communicate with the remote cluster. */
+    mode: string;
+    /** The `skip_unavailable` setting used for this remote cluster. */
+    skip_unavailable: boolean;
+    /** Transport compression setting used for this remote cluster. */
+    transport_compress: string;
+    /** Health status of the cluster, based on the state of its primary and replica shards. */
+    status: HealthStatus;
+    /** The list of Elasticsearch versions used by the nodes on the remote cluster. */
+    version: VersionString[];
+    /** The total count of nodes in the remote cluster. */
+    nodes_count: integer;
+    /** The total number of shards in the remote cluster. */
+    shards_count: integer;
+    /** The total number of indices in the remote cluster. */
+    indices_count: integer;
+    /** Total data set size, in bytes, of all shards assigned to selected nodes. */
+    indices_total_size_in_bytes: long;
+    /** Total data set size of all shards assigned to selected nodes, as a human-readable string. */
+    indices_total_size?: string;
+    /** Maximum amount of memory, in bytes, available for use by the heap across the nodes of the remote cluster. */
+    max_heap_in_bytes: long;
+    /** Maximum amount of memory available for use by the heap across the nodes of the remote cluster, as a human-readable string. */
+    max_heap?: string;
+    /** Total amount, in bytes, of physical memory across the nodes of the remote cluster. */
+    mem_total_in_bytes: long;
+    /** Total amount of physical memory across the nodes of the remote cluster, as a human-readable string. */
+    mem_total?: string;
+}
 export interface ClusterStatsRequest extends RequestBase {
     /** Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. */
     node_id?: NodeIds;
@@ -17233,6 +17502,8 @@ export interface ClusterStatsStatsResponseBase extends NodesNodesResponseBase {
     status: HealthStatus;
     /** Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. */
     timestamp: long;
+    /** Cross-cluster stats */
+    ccs: ClusterStatsCCSStats;
 }
 export interface ConnectorConnector {
     api_key_id?: string;
@@ -19628,7 +19899,7 @@ export interface IlmExplainLifecycleLifecycleExplainManaged {
     lifecycle_date?: DateTime;
     lifecycle_date_millis?: EpochTime<UnitMillis>;
     managed: true;
-    phase: Name;
+    phase?: Name;
     phase_time?: DateTime;
     phase_time_millis?: EpochTime<UnitMillis>;
     policy?: Name;
@@ -20840,7 +21111,16 @@ export interface IndicesCloseResponse {
     shards_acknowledged: boolean;
 }
 export interface IndicesCreateRequest extends RequestBase {
-    /** Name of the index you wish to create. */
+    /** Name of the index you wish to create.
+      * Index names must meet the following criteria:
+      *
+      * * Lowercase only
+      * * Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#`
+      * * Indices prior to 7.0 could contain a colon (`:`), but that has been deprecated and will not be supported in later versions
+      * * Cannot start with `-`, `_`, or `+`
+      * * Cannot be `.` or `..`
+      * * Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster)
+      * * Names starting with `.` are deprecated, except for hidden indices and internal indices managed by plugins */
     index: IndexName;
     /** 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. */
@@ -24447,7 +24727,9 @@ export interface InferenceRateLimitSetting {
     requests_per_minute?: integer;
 }
 export interface InferenceRequestChatCompletion {
-    /** A list of objects representing the conversation. */
+    /** A list of objects representing the conversation.
+      * Requests should generally only add new messages from the user (role `user`).
+      * The other message roles (`assistant`, `system`, or `tool`) should generally only be copied from the response to a previous completion request, such that the messages array is built up throughout a conversation. */
     messages: InferenceMessage[];
     /** The ID of the model to use. */
     model?: string;
@@ -26011,15 +26293,16 @@ export interface IngestPipelineProcessor extends IngestProcessorBase {
     /** Whether to ignore missing pipelines instead of failing. */
     ignore_missing_pipeline?: boolean;
 }
-export interface IngestPipelineSimulation {
+export interface IngestPipelineProcessorResult {
     doc?: IngestDocumentSimulation;
     tag?: string;
     processor_type?: string;
-    status?: WatcherActionStatusOptions;
+    status?: IngestPipelineSimulationStatusOptions;
     description?: string;
     ignored_error?: ErrorCause;
     error?: ErrorCause;
 }
+export type IngestPipelineSimulationStatusOptions = 'success' | 'error' | 'error_ignored' | 'skipped' | 'dropped';
 export interface IngestProcessorBase {
     /** Description of the processor.
       * Useful for describing the purpose of the processor or its configuration. */
@@ -26286,7 +26569,7 @@ export type IngestShapeType = 'geo_shape' | 'shape';
 export interface IngestSimulateDocumentResult {
     doc?: IngestDocumentSimulation;
     error?: ErrorCause;
-    processor_results?: IngestPipelineSimulation[];
+    processor_results?: IngestPipelineProcessorResult[];
 }
 export interface IngestSortProcessor extends IngestProcessorBase {
     /** The field to be sorted. */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elastic/elasticsearch",
-  "version": "9.0.1",
-  "versionCanary": "9.0.1-canary.0",
+  "version": "9.0.2",
+  "versionCanary": "9.0.2-canary.0",
   "description": "The official Elasticsearch client for Node.js",
   "main": "./index.js",
   "types": "index.d.ts",