@elastic/schemas 0.4.3 → 0.4.5

package/lib/cjs/es/json/inference.put_jinaai.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_jinaai", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "jinaai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `embedding` and text_embedding` task types.\nNot applicable to the `rerank` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAIServiceType", "description": "The type of service supported for the specified task type. In this case, `jinaai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `jinaai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" } }, "required": ["task_type", "jinaai_inference_id", "service", "service_settings"], "description": "Create an JinaAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `jinaai` service.\n\nTo review the available `rerank` models, refer to <https://jina.ai/reranker>.\nTo review the available `embedding` and `text_embedding` models, refer to <https://jina.ai/embeddings/>." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_jinaai", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `embedding` and text_embedding` task types.\nNot applicable to the `rerank` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAIServiceType", "description": "The type of service supported for the specified task type. In this case, `jinaai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `jinaai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__JinaAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "jinaai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "jinaai_inference_id", "service", "service_settings"], "description": "Create an JinaAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `jinaai` service.\n\nTo review the available `rerank` models, refer to <https://jina.ai/reranker>.\nTo review the available `embedding` and `text_embedding` models, refer to <https://jina.ai/embeddings/>." }

package/lib/cjs/es/json/inference.put_llama.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_llama", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__LlamaTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "llama_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__LlamaServiceType", "description": "The type of service supported for the specified task type. In this case, `llama`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__LlamaServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `llama` service.", "x-found-in": "body" } }, "required": ["task_type", "llama_inference_id", "service", "service_settings"], "description": "Create a Llama inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `llama` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_llama", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__LlamaServiceType", "description": "The type of service supported for the specified task type. In this case, `llama`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__LlamaServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `llama` service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__LlamaTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "llama_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "llama_inference_id", "service", "service_settings"], "description": "Create a Llama inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `llama` service." }

package/lib/cjs/es/json/inference.put_mistral.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_mistral", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__MistralTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "mistral_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__MistralServiceType", "description": "The type of service supported for the specified task type. In this case, `mistral`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__MistralServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `mistral` service.", "x-found-in": "body" } }, "required": ["task_type", "mistral_inference_id", "service", "service_settings"], "description": "Create a Mistral inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `mistral` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_mistral", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__MistralServiceType", "description": "The type of service supported for the specified task type. In this case, `mistral`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__MistralServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `mistral` service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__MistralTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "mistral_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "mistral_inference_id", "service", "service_settings"], "description": "Create a Mistral inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `mistral` service." }

package/lib/cjs/es/json/inference.put_nvidia.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_nvidia", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__NvidiaTaskType", "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.", "x-found-in": "path" }, "nvidia_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__NvidiaServiceType", "description": "The type of service supported for the specified task type. In this case, `nvidia`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__NvidiaServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `nvidia` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__NvidiaTaskSettings", "description": "Settings to configure the inference task.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.\nThese settings are specific to the task type you specified.", "x-found-in": "body" } }, "required": ["task_type", "nvidia_inference_id", "service", "service_settings"], "description": "Create an Nvidia inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `nvidia` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_nvidia", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__NvidiaServiceType", "description": "The type of service supported for the specified task type. In this case, `nvidia`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__NvidiaServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `nvidia` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__NvidiaTaskSettings", "description": "Settings to configure the inference task.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__NvidiaTaskType", "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.", "x-found-in": "path" }, "nvidia_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "nvidia_inference_id", "service", "service_settings"], "description": "Create an Nvidia inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `nvidia` service." }

package/lib/cjs/es/json/inference.put_openai.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_openai", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__OpenAITaskType", "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.", "x-found-in": "path" }, "openai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__OpenAIServiceType", "description": "The type of service supported for the specified task type. In this case, `openai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__OpenAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `openai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__OpenAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" } }, "required": ["task_type", "openai_inference_id", "service", "service_settings"], "description": "Create an OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_openai", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__OpenAIServiceType", "description": "The type of service supported for the specified task type. In this case, `openai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__OpenAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `openai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__OpenAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__OpenAITaskType", "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.", "x-found-in": "path" }, "openai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "openai_inference_id", "service", "service_settings"], "description": "Create an OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs." }

package/lib/cjs/es/json/inference.put_openshift_ai.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_openshift_ai", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__OpenShiftAiTaskType", "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.", "x-found-in": "path" }, "openshiftai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__OpenShiftAiServiceType", "description": "The type of service supported for the specified task type. In this case, `openshift_ai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__OpenShiftAiServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `openshift_ai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__OpenShiftAiTaskSettings", "description": "Settings to configure the inference task.\nApplies only to the `rerank` task type.\nNot applicable to the `text_embedding`, `completion`, or `chat_completion` task types.\nThese settings are specific to the task type you specified.", "x-found-in": "body" } }, "required": ["task_type", "openshiftai_inference_id", "service", "service_settings"], "description": "Create an OpenShift AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openshift_ai` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_openshift_ai", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__OpenShiftAiServiceType", "description": "The type of service supported for the specified task type. In this case, `openshift_ai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__OpenShiftAiServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `openshift_ai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__OpenShiftAiTaskSettings", "description": "Settings to configure the inference task.\nApplies only to the `rerank` task type.\nNot applicable to the `text_embedding`, `completion`, or `chat_completion` task types.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__OpenShiftAiTaskType", "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.", "x-found-in": "path" }, "openshiftai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "openshiftai_inference_id", "service", "service_settings"], "description": "Create an OpenShift AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openshift_ai` service." }

package/lib/cjs/es/json/inference.put_voyageai.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_voyageai", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__VoyageAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "voyageai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__VoyageAIServiceType", "description": "The type of service supported for the specified task type. In this case, `voyageai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__VoyageAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `voyageai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__VoyageAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" } }, "required": ["task_type", "voyageai_inference_id", "service", "service_settings"], "description": "Create a VoyageAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `voyageai` service.\n\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_voyageai", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__VoyageAIServiceType", "description": "The type of service supported for the specified task type. In this case, `voyageai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__VoyageAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `voyageai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__VoyageAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__VoyageAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "voyageai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "voyageai_inference_id", "service", "service_settings"], "description": "Create a VoyageAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `voyageai` service.\n\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources." }

package/lib/cjs/es/json/inference.put_watsonx.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_watsonx", "type": "object", "properties": { "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__WatsonxTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "watsonx_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion` or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__WatsonxServiceType", "description": "The type of service supported for the specified task type. In this case, `watsonxai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__WatsonxServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `watsonxai` service.", "x-found-in": "body" } }, "required": ["task_type", "watsonx_inference_id", "service", "service_settings"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_watsonx", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be created.", "x-found-in": "query" }, "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion` or `chat_completion` task types.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__WatsonxServiceType", "description": "The type of service supported for the specified task type. In this case, `watsonxai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__WatsonxServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `watsonxai` service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__WatsonxTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "watsonx_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "watsonx_inference_id", "service", "service_settings"], "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." }

package/lib/cjs/es/json/inference.rerank.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.rerank", "type": "object", "properties": { "inference_id": { "type": "string", "description": "The unique identifier for the inference endpoint.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "query": { "$ref": "./inference.rerank.json#/$defs/inference.rerank__RerankQuery", "description": "Query input.\nThe query can be specified as a single string, or as an object.\nThe object form additionally allows specifying non-text inputs, such as images.\n\n> info\n> Only the `elastic` service currently supports non-text queries for the `rerank` task. For all other services, the query must be a string.\n\nstring example:\n```\n\"query\": \"some query text\"\n```\nobject example:\n```\n\"query\": {\n  \"type\": \"image\",\n  \"format\": \"base64\",\n  \"value\": \"data:image/jpeg;base64,...\"\n}\n```", "x-found-in": "body" }, "input": { "$ref": "./inference.rerank.json#/$defs/inference.rerank__RerankInput", "description": "The documents to rank.\nThe input can be specified as a single string or an array of strings, or as an object or an array of objects.\nThe object form additionally allows specifying non-text inputs, such as images.\n\n> info\n> Only the `elastic` service currently supports non-text inputs for the `rerank` task. For all other services, the input must be a string or an array of strings.\n\nstring example:\n```\n\"input\": \"some document text\"\n```\nstring array example:\n```\n\"input\": [\"some document text\", \"some more document text\"]\n```\nobject example:\n```\n\"input\": {\n  \"type\": \"image\",\n  \"format\": \"base64\",\n  \"value\": \"data:image/jpeg;base64,...\"\n}\n```\nobject array example:\n```\n\"input\": [\n  {\n    \"type\": \"text\",\n    \"format\": \"text\",\n    \"value\": \"some document text\"\n  },\n  {\n    \"type\": \"image\",\n    \"format\": \"base64\",\n    \"value\": \"data:image/jpeg;base64,...\"\n  }\n]\n```", "x-found-in": "body" }, "return_documents": { "type": "boolean", "description": "Include the document text in the response.", "x-found-in": "body" }, "top_n": { "type": "number", "description": "Limit the response to the top N documents.", "x-found-in": "body" }, "task_settings": { "description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.", "x-found-in": "body" } }, "required": ["inference_id", "query", "input"], "description": "Perform reranking inference on the service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.rerank", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "query": { "$ref": "./inference.rerank.json#/$defs/inference.rerank__RerankQuery", "description": "Query input.\nThe query can be specified as a single string, or as an object.\nThe object form additionally allows specifying non-text inputs, such as images.\n\n> info\n> Only the `elastic` service currently supports non-text queries for the `rerank` task. For all other services, the query must be a string.\n\nstring example:\n```\n\"query\": \"some query text\"\n```\nobject example:\n```\n\"query\": {\n  \"type\": \"image\",\n  \"format\": \"base64\",\n  \"value\": \"data:image/jpeg;base64,...\"\n}\n```", "x-found-in": "body" }, "input": { "$ref": "./inference.rerank.json#/$defs/inference.rerank__RerankInput", "description": "The documents to rank.\nThe input can be specified as a single string or an array of strings, or as an object or an array of objects.\nThe object form additionally allows specifying non-text inputs, such as images.\n\n> info\n> Only the `elastic` service currently supports non-text inputs for the `rerank` task. For all other services, the input must be a string or an array of strings.\n\nstring example:\n```\n\"input\": \"some document text\"\n```\nstring array example:\n```\n\"input\": [\"some document text\", \"some more document text\"]\n```\nobject example:\n```\n\"input\": {\n  \"type\": \"image\",\n  \"format\": \"base64\",\n  \"value\": \"data:image/jpeg;base64,...\"\n}\n```\nobject array example:\n```\n\"input\": [\n  {\n    \"type\": \"text\",\n    \"format\": \"text\",\n    \"value\": \"some document text\"\n  },\n  {\n    \"type\": \"image\",\n    \"format\": \"base64\",\n    \"value\": \"data:image/jpeg;base64,...\"\n  }\n]\n```", "x-found-in": "body" }, "return_documents": { "type": "boolean", "description": "Include the document text in the response.", "x-found-in": "body" }, "top_n": { "type": "number", "description": "Limit the response to the top N documents.", "x-found-in": "body" }, "task_settings": { "description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.", "x-found-in": "body" }, "inference_id": { "type": "string", "description": "The unique identifier for the inference endpoint.", "x-found-in": "path" } }, "required": ["inference_id", "query", "input"], "description": "Perform reranking inference on the service." }

package/lib/cjs/es/json/inference.sparse_embedding.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.sparse_embedding", "type": "object", "properties": { "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "input": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Inference input.\nEither a string or an array of strings.", "x-found-in": "body" }, "task_settings": { "description": "Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.", "x-found-in": "body" } }, "required": ["inference_id", "input"], "description": "Perform sparse embedding inference on the service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.sparse_embedding", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "input": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Inference input.\nEither a string or an array of strings.", "x-found-in": "body" }, "task_settings": { "description": "Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.", "x-found-in": "body" }, "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" } }, "required": ["inference_id", "input"], "description": "Perform sparse embedding inference on the service." }

package/lib/cjs/es/json/inference.stream_completion.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.stream_completion", "type": "object", "properties": { "inference_id": { "type": "string", "description": "The unique identifier for the inference endpoint.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "input": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\nNOTE: Inference endpoints for the completion task type currently only support a single string as input.", "x-found-in": "body" }, "task_settings": { "description": "Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.", "x-found-in": "body" } }, "required": ["inference_id", "input"], "description": "Perform streaming completion inference on the service.\n\nGet real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation.\nThis API works only with the completion task type.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, 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.\n\nThis API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.stream_completion", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "input": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\nNOTE: Inference endpoints for the completion task type currently only support a single string as input.", "x-found-in": "body" }, "task_settings": { "description": "Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.", "x-found-in": "body" }, "inference_id": { "type": "string", "description": "The unique identifier for the inference endpoint.", "x-found-in": "path" } }, "required": ["inference_id", "input"], "description": "Perform streaming completion inference on the service.\n\nGet real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation.\nThis API works only with the completion task type.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, 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.\n\nThis API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming." }

package/lib/cjs/es/json/inference.text_embedding.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.text_embedding", "type": "object", "properties": { "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "input": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Inference input.\nEither a string or an array of strings.", "x-found-in": "body" }, "input_type": { "type": "string", "description": "The input data type for the text embedding model. Possible values include:\n* `SEARCH`\n* `INGEST`\n* `CLASSIFICATION`\n* `CLUSTERING`\nNot all services support all values. Unsupported values will trigger a validation exception.\nAccepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info.\n\n> info\n> The `input_type` parameter specified on the root level of the request body will take precedence over the `input_type` parameter specified in `task_settings`.", "x-found-in": "body" }, "task_settings": { "description": "Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.", "x-found-in": "body" } }, "required": ["inference_id", "input"], "description": "Perform text embedding inference on the service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.text_embedding", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "input": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Inference input.\nEither a string or an array of strings.", "x-found-in": "body" }, "input_type": { "type": "string", "description": "The input data type for the text embedding model. Possible values include:\n* `SEARCH`\n* `INGEST`\n* `CLASSIFICATION`\n* `CLUSTERING`\nNot all services support all values. Unsupported values will trigger a validation exception.\nAccepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info.\n\n> info\n> The `input_type` parameter specified on the root level of the request body will take precedence over the `input_type` parameter specified in `task_settings`.", "x-found-in": "body" }, "task_settings": { "description": "Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.", "x-found-in": "body" }, "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" } }, "required": ["inference_id", "input"], "description": "Perform text embedding inference on the service." }

package/lib/cjs/es/json/inference.update.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.update", "type": "object", "properties": { "inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskType", "description": "The type of inference task that the model performs.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be updated.\nThe default depends on the task type: 120s for `completion` and `chat_completion`, and 30s for all other task types.", "x-found-in": "query" } }, "required": ["inference_id"], "description": "Update an inference endpoint.\n\nModify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.update", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the amount of time to wait for the inference endpoint to be updated.\nThe default depends on the task type: 120s for `completion` and `chat_completion`, and 30s for all other task types.", "x-found-in": "query" }, "inference_config": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceEndpoint", "x-found-in": "body" }, "inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskType", "description": "The type of inference task that the model performs.", "x-found-in": "path" } }, "required": ["inference_id"], "description": "Update an inference endpoint.\n\nModify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs." }

package/lib/cjs/es/json/ingest.delete_geoip_database.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.delete_geoip_database", "type": "object", "properties": { "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A comma-separated list of geoip database configurations to delete", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "required": ["id"], "description": "Delete GeoIP database configurations.\n\nDelete one or more IP geolocation database configurations." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.delete_geoip_database", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A comma-separated list of geoip database configurations to delete", "x-found-in": "path" } }, "required": ["id"], "description": "Delete GeoIP database configurations.\n\nDelete one or more IP geolocation database configurations." }

package/lib/cjs/es/json/ingest.delete_ip_location_database.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.delete_ip_location_database", "type": "object", "properties": { "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A comma-separated list of IP location database configurations.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" } }, "required": ["id"], "description": "Delete IP geolocation database configurations." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.delete_ip_location_database", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A comma-separated list of IP location database configurations.", "x-found-in": "path" } }, "required": ["id"], "description": "Delete IP geolocation database configurations." }

package/lib/cjs/es/json/ingest.delete_pipeline.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.delete_pipeline", "type": "object", "properties": { "id": { "type": "string", "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 `*`.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "required": ["id"], "description": "Delete pipelines.\n\nDelete one or more ingest pipelines." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.delete_pipeline", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "id": { "type": "string", "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 `*`.", "x-found-in": "path" } }, "required": ["id"], "description": "Delete pipelines.\n\nDelete one or more ingest pipelines." }

package/lib/cjs/es/json/ingest.get_pipeline.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.get_pipeline", "type": "object", "properties": { "id": { "type": "string", "description": "Comma-separated list of pipeline IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all ingest pipelines, omit this parameter or use `*`.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "summary": { "type": "boolean", "description": "Return pipelines without their definitions", "x-found-in": "query" } }, "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.get_pipeline", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "summary": { "type": "boolean", "description": "Return pipelines without their definitions", "x-found-in": "query" }, "id": { "type": "string", "description": "Comma-separated list of pipeline IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all ingest pipelines, omit this parameter or use `*`.", "x-found-in": "path" } }, "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline." }

package/lib/cjs/es/json/ingest.put_geoip_database.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_geoip_database", "type": "object", "properties": { "id": { "type": "string", "description": "ID of the database configuration to create or update.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "type": "string", "description": "The provider-assigned name of the IP geolocation database to download.", "x-found-in": "body" }, "maxmind": { "$ref": "./ingest._types.json#/$defs/ingest._types__Maxmind", "description": "The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured.", "x-found-in": "body" } }, "required": ["id", "name", "maxmind"], "description": "Create or update a GeoIP database configuration.\n\nRefer to the create or update IP geolocation database configuration API." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_geoip_database", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "type": "string", "description": "The provider-assigned name of the IP geolocation database to download.", "x-found-in": "body" }, "maxmind": { "$ref": "./ingest._types.json#/$defs/ingest._types__Maxmind", "description": "The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured.", "x-found-in": "body" }, "id": { "type": "string", "description": "ID of the database configuration to create or update.", "x-found-in": "path" } }, "required": ["id", "name", "maxmind"], "description": "Create or update a GeoIP database configuration.\n\nRefer to the create or update IP geolocation database configuration API." }

package/lib/cjs/es/json/ingest.put_ip_location_database.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_ip_location_database", "type": "object", "properties": { "id": { "type": "string", "description": "The database configuration identifier.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" } }, "required": ["id"], "description": "Create or update an IP geolocation database configuration." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_ip_location_database", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "configuration": { "$ref": "./ingest._types.json#/$defs/ingest._types__DatabaseConfiguration", "x-found-in": "body" }, "id": { "type": "string", "description": "The database configuration identifier.", "x-found-in": "path" } }, "required": ["id"], "description": "Create or update an IP geolocation database configuration." }

package/lib/cjs/es/json/ingest.put_pipeline.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_pipeline", "type": "object", "properties": { "id": { "type": "string", "description": "ID of the ingest pipeline to create or update.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "if_version": { "type": "number", "description": "Required version for optimistic concurrency control for pipeline updates", "x-found-in": "query" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "description": { "type": "string", "description": "Description of the ingest pipeline.", "x-found-in": "body" }, "on_failure": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__ProcessorContainer" }, "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.", "x-found-in": "body" }, "processors": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__ProcessorContainer" }, "description": "Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.", "x-found-in": "body" }, "version": { "type": "number", "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.", "x-found-in": "body" }, "deprecated": { "type": "boolean", "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.", "x-found-in": "body" }, "field_access_pattern": { "$ref": "./ingest._types.json#/$defs/ingest._types__FieldAccessPattern", "description": "Controls how processors in this pipeline should read and write data on a document's source.", "x-found-in": "body" } }, "required": ["id"], "description": "Create or update a pipeline.\n\nChanges made using this API take effect immediately." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_pipeline", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "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.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "if_version": { "type": "number", "description": "Required version for optimistic concurrency control for pipeline updates", "x-found-in": "query" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "description": { "type": "string", "description": "Description of the ingest pipeline.", "x-found-in": "body" }, "on_failure": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__ProcessorContainer" }, "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.", "x-found-in": "body" }, "processors": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__ProcessorContainer" }, "description": "Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.", "x-found-in": "body" }, "version": { "type": "number", "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.", "x-found-in": "body" }, "deprecated": { "type": "boolean", "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.", "x-found-in": "body" }, "field_access_pattern": { "$ref": "./ingest._types.json#/$defs/ingest._types__FieldAccessPattern", "description": "Controls how processors in this pipeline should read and write data on a document's source.", "x-found-in": "body" }, "id": { "type": "string", "description": "ID of the ingest pipeline to create or update.", "x-found-in": "path" } }, "required": ["id"], "description": "Create or update a pipeline.\n\nChanges made using this API take effect immediately." }

package/lib/cjs/es/json/ingest.simulate.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.simulate", "type": "object", "properties": { "id": { "type": "string", "description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.", "x-found-in": "path" }, "verbose": { "type": "boolean", "description": "If `true`, the response includes output data for each processor in the executed pipeline.", "x-found-in": "query" }, "docs": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__Document" }, "description": "Sample documents to test in the pipeline.", "x-found-in": "body" }, "pipeline": { "$ref": "./ingest._types.json#/$defs/ingest._types__Pipeline", "description": "The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", "x-found-in": "body" } }, "required": ["docs"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.simulate", "type": "object", "properties": { "verbose": { "type": "boolean", "description": "If `true`, the response includes output data for each processor in the executed pipeline.", "x-found-in": "query" }, "docs": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__Document" }, "description": "Sample documents to test in the pipeline.", "x-found-in": "body" }, "pipeline": { "$ref": "./ingest._types.json#/$defs/ingest._types__Pipeline", "description": "The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", "x-found-in": "body" }, "id": { "type": "string", "description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.", "x-found-in": "path" } }, "required": ["docs"], "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." }

package/lib/cjs/es/json/logstash.put_pipeline.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "logstash.put_pipeline", "type": "object", "properties": { "id": { "type": "string", "description": "An identifier for the pipeline.\nPipeline IDs must begin with a letter or underscore and contain only letters, underscores, dashes, hyphens and numbers.", "x-found-in": "path" } }, "required": ["id"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "logstash.put_pipeline", "type": "object", "properties": { "pipeline": { "$ref": "./logstash._types.json#/$defs/logstash._types__Pipeline", "x-found-in": "body" }, "id": { "type": "string", "description": "An identifier for the pipeline.\nPipeline IDs must begin with a letter or underscore and contain only letters, underscores, dashes, hyphens and numbers.", "x-found-in": "path" } }, "required": ["id"], "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." }

package/lib/cjs/es/json/mget.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "mget", "type": "object", "properties": { "index": { "type": "string", "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.", "x-found-in": "path" }, "preference": { "type": "string", "description": "Specifies the node or shard the operation should be performed on. Random by default.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes relevant shards before retrieving documents.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "Custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "True or false to return the `_source` field or not, or a list of fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "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.", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "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.", "x-found-in": "query" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.", "x-found-in": "query" }, "docs": { "type": "array", "items": { "$ref": "./_global.mget.json#/$defs/_global.mget__Operation" }, "description": "The documents you want to retrieve. Required if no index is specified in the request URI.", "x-found-in": "body" }, "ids": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", "x-found-in": "body" } }, "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "mget", "type": "object", "properties": { "preference": { "type": "string", "description": "Specifies the node or shard the operation should be performed on. Random by default.", "x-found-in": "query" }, "realtime": { "type": "boolean", "description": "If `true`, the request is real-time as opposed to near-real-time.", "x-found-in": "query" }, "refresh": { "type": "boolean", "description": "If `true`, the request refreshes relevant shards before retrieving documents.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "Custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "True or false to return the `_source` field or not, or a list of fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "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.", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "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.", "x-found-in": "query" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "If `true`, retrieves the document fields stored in the index rather than the document `_source`.", "x-found-in": "query" }, "docs": { "type": "array", "items": { "$ref": "./_global.mget.json#/$defs/_global.mget__Operation" }, "description": "The documents you want to retrieve. Required if no index is specified in the request URI.", "x-found-in": "body" }, "ids": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.", "x-found-in": "body" }, "index": { "type": "string", "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.", "x-found-in": "path" } }, "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." }

package/lib/cjs/es/json/ml.close_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.close_job", "type": "object", "properties": { "job_id": { "type": "string", "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.", "x-found-in": "path" }, "allow_no_match": { "type": "boolean", "description": "Refer to the description for the `allow_no_match` query parameter.", "x-found-in": "body" }, "force": { "type": "boolean", "description": "Refer to the descriptiion for the `force` query parameter.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `timeout` query parameter.", "x-found-in": "body" } }, "required": ["job_id"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.close_job", "type": "object", "properties": { "allow_no_match": { "type": "boolean", "description": "Refer to the description for the `allow_no_match` query parameter.", "x-found-in": "body" }, "force": { "type": "boolean", "description": "Refer to the descriptiion for the `force` query parameter.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `timeout` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "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.", "x-found-in": "path" } }, "required": ["job_id"], "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." }

package/lib/cjs/es/json/ml.delete_data_frame_analytics.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_data_frame_analytics", "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the data frame analytics job.", "x-found-in": "path" }, "force": { "type": "boolean", "description": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The time to wait for the job to be deleted.", "x-found-in": "query" } }, "required": ["id"], "description": "Delete a data frame analytics job." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_data_frame_analytics", "type": "object", "properties": { "force": { "type": "boolean", "description": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The time to wait for the job to be deleted.", "x-found-in": "query" }, "id": { "type": "string", "description": "Identifier for the data frame analytics job.", "x-found-in": "path" } }, "required": ["id"], "description": "Delete a data frame analytics job." }

package/lib/cjs/es/json/ml.delete_datafeed.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_datafeed", "type": "object", "properties": { "datafeed_id": { "type": "string", "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.", "x-found-in": "path" }, "force": { "type": "boolean", "description": "Use to forcefully delete a started datafeed; this method is quicker than\nstopping and deleting the datafeed.", "x-found-in": "query" } }, "required": ["datafeed_id"], "description": "Delete a datafeed." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_datafeed", "type": "object", "properties": { "force": { "type": "boolean", "description": "Use to forcefully delete a started datafeed; this method is quicker than\nstopping and deleting the datafeed.", "x-found-in": "query" }, "datafeed_id": { "type": "string", "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.", "x-found-in": "path" } }, "required": ["datafeed_id"], "description": "Delete a datafeed." }

package/lib/cjs/es/json/ml.delete_expired_data.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_expired_data", "type": "object", "properties": { "job_id": { "type": "string", "description": "Identifier for an anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression.", "x-found-in": "path" }, "requests_per_second": { "type": "number", "description": "The desired requests per second for the deletion processes. The default\nbehavior is no throttling.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "How long can the underlying delete processes run until they are canceled.", "x-found-in": "body" } }, "description": "Delete expired ML data.\n\nDelete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting the\n`<job_id>`." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_expired_data", "type": "object", "properties": { "requests_per_second": { "type": "number", "description": "The desired requests per second for the deletion processes. The default\nbehavior is no throttling.", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "How long can the underlying delete processes run until they are canceled.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for an anomaly detection job. It can be a job identifier, a\ngroup name, or a wildcard expression.", "x-found-in": "path" } }, "description": "Delete expired ML data.\n\nDelete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting the\n`<job_id>`." }

package/lib/cjs/es/json/ml.delete_forecast.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_forecast", "type": "object", "properties": { "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "forecast_id": { "type": "string", "description": "A comma-separated list of forecast identifiers. If you do not specify\nthis optional parameter or if you specify `_all` or `*` the API deletes\nall forecasts from the job.", "x-found-in": "path" }, "allow_no_forecasts": { "type": "boolean", "description": "Specifies whether an error occurs when there are no forecasts. In\nparticular, if this parameter is set to `false` and there are no\nforecasts associated with the job, attempts to delete all forecasts\nreturn an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the period of time to wait for the completion of the delete\noperation. When this period of time elapses, the API fails and returns an\nerror.", "x-found-in": "query" } }, "required": ["job_id"], "description": "Delete forecasts from a job.\n\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_forecast", "type": "object", "properties": { "allow_no_forecasts": { "type": "boolean", "description": "Specifies whether an error occurs when there are no forecasts. In\nparticular, if this parameter is set to `false` and there are no\nforecasts associated with the job, attempts to delete all forecasts\nreturn an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the period of time to wait for the completion of the delete\noperation. When this period of time elapses, the API fails and returns an\nerror.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "forecast_id": { "type": "string", "description": "A comma-separated list of forecast identifiers. If you do not specify\nthis optional parameter or if you specify `_all` or `*` the API deletes\nall forecasts from the job.", "x-found-in": "path" } }, "required": ["job_id"], "description": "Delete forecasts from a job.\n\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire." }

package/lib/cjs/es/json/ml.delete_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_job", "type": "object", "properties": { "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "force": { "type": "boolean", "description": "Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.", "x-found-in": "query" }, "delete_user_annotations": { "type": "boolean", "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.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "Specifies whether the request should return immediately or wait until the\njob deletion completes.", "x-found-in": "query" } }, "required": ["job_id"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_job", "type": "object", "properties": { "force": { "type": "boolean", "description": "Use to forcefully delete an opened job; this method is quicker than\nclosing and deleting the job.", "x-found-in": "query" }, "delete_user_annotations": { "type": "boolean", "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.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "Specifies whether the request should return immediately or wait until the\njob deletion completes.", "x-found-in": "query" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" } }, "required": ["job_id"], "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." }

package/lib/cjs/es/json/ml.delete_trained_model.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_trained_model", "type": "object", "properties": { "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" }, "force": { "type": "boolean", "description": "Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "required": ["model_id"], "description": "Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.delete_trained_model", "type": "object", "properties": { "force": { "type": "boolean", "description": "Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "model_id": { "type": "string", "description": "The unique identifier of the trained model.", "x-found-in": "path" } }, "required": ["model_id"], "description": "Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline." }

package/lib/cjs/es/json/ml.explain_data_frame_analytics.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.explain_data_frame_analytics", "type": "object", "properties": { "id": { "type": "string", "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.", "x-found-in": "path" }, "source": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalyticsSource", "description": "The configuration of how to source the analysis data. It requires an\nindex. Optionally, query and _source may be specified.", "x-found-in": "body" }, "dest": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalyticsDestination", "description": "The destination configuration, consisting of index and optionally\nresults_field (ml by default).", "x-found-in": "body" }, "analysis": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalysisContainer", "description": "The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description of the job.", "x-found-in": "body" }, "model_memory_limit": { "type": "string", "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 to\ncreate data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", "x-found-in": "body" }, "max_num_threads": { "type": "number", "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.", "x-found-in": "body" }, "analyzed_fields": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalysisAnalyzedFields", "description": "Specify includes and/or excludes patterns to select which fields will be\nincluded in the analysis. The patterns specified in excludes are applied\nlast, therefore excludes takes precedence. In other words, if the same\nfield is specified in both includes and excludes, then the field will not\nbe included in the analysis.", "x-found-in": "body" }, "allow_lazy_start": { "type": "boolean", "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", "x-found-in": "body" } }, "description": "Explain data frame analytics config.\n\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.explain_data_frame_analytics", "type": "object", "properties": { "source": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalyticsSource", "description": "The configuration of how to source the analysis data. It requires an\nindex. Optionally, query and _source may be specified.", "x-found-in": "body" }, "dest": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalyticsDestination", "description": "The destination configuration, consisting of index and optionally\nresults_field (ml by default).", "x-found-in": "body" }, "analysis": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalysisContainer", "description": "The analysis configuration, which contains the information necessary to\nperform one of the following types of analysis: classification, outlier\ndetection, or regression.", "x-found-in": "body" }, "description": { "type": "string", "description": "A description of the job.", "x-found-in": "body" }, "model_memory_limit": { "type": "string", "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 to\ncreate data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", "x-found-in": "body" }, "max_num_threads": { "type": "number", "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.", "x-found-in": "body" }, "analyzed_fields": { "$ref": "./ml._types.json#/$defs/ml._types__DataframeAnalysisAnalyzedFields", "description": "Specify includes and/or excludes patterns to select which fields will be\nincluded in the analysis. The patterns specified in excludes are applied\nlast, therefore excludes takes precedence. In other words, if the same\nfield is specified in both includes and excludes, then the field will not\nbe included in the analysis.", "x-found-in": "body" }, "allow_lazy_start": { "type": "boolean", "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", "x-found-in": "body" }, "id": { "type": "string", "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.", "x-found-in": "path" } }, "description": "Explain data frame analytics config.\n\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation." }

package/lib/cjs/es/json/ml.flush_job.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.flush_job", "type": "object", "properties": { "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "advance_time": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `advance_time` query parameter.", "x-found-in": "body" }, "calc_interim": { "type": "boolean", "description": "Refer to the description for the `calc_interim` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "skip_time": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `skip_time` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" } }, "required": ["job_id"], "description": "Force buffered data to be processed.\n\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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.flush_job", "type": "object", "properties": { "advance_time": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `advance_time` query parameter.", "x-found-in": "body" }, "calc_interim": { "type": "boolean", "description": "Refer to the description for the `calc_interim` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "skip_time": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `skip_time` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" } }, "required": ["job_id"], "description": "Force buffered data to be processed.\n\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." }

package/lib/cjs/es/json/ml.forecast.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.forecast", "type": "object", "properties": { "job_id": { "type": "string", "description": "Identifier for the anomaly detection job. The job must be open when you\ncreate a forecast; otherwise, an error occurs.", "x-found-in": "path" }, "duration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `duration` query parameter.", "x-found-in": "body" }, "expires_in": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `expires_in` query parameter.", "x-found-in": "body" }, "max_model_memory": { "type": "string", "description": "Refer to the description for the `max_model_memory` query parameter.", "x-found-in": "body" } }, "required": ["job_id"], "description": "Predict future behavior of a time series.\n\nForecasts are not supported for jobs that perform population analysis; an\nerror occurs if you try to create a forecast for a job that has an\n`over_field_name` in its configuration. Forcasts predict future behavior\nbased on historical data." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.forecast", "type": "object", "properties": { "duration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `duration` query parameter.", "x-found-in": "body" }, "expires_in": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Refer to the description for the `expires_in` query parameter.", "x-found-in": "body" }, "max_model_memory": { "type": "string", "description": "Refer to the description for the `max_model_memory` query parameter.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job. The job must be open when you\ncreate a forecast; otherwise, an error occurs.", "x-found-in": "path" } }, "required": ["job_id"], "description": "Predict future behavior of a time series.\n\nForecasts are not supported for jobs that perform population analysis; an\nerror occurs if you try to create a forecast for a job that has an\n`over_field_name` in its configuration. Forcasts predict future behavior\nbased on historical data." }

package/lib/cjs/es/json/ml.get_buckets.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_buckets", "type": "object", "properties": { "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "timestamp": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "The timestamp of a single bucket result. If you do not specify this\nparameter, the API returns information about all buckets.", "x-found-in": "path" }, "anomaly_score": { "type": "number", "description": "Refer to the description for the `anomaly_score` query parameter.", "x-found-in": "body" }, "desc": { "type": "boolean", "description": "Refer to the description for the `desc` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "exclude_interim": { "type": "boolean", "description": "Refer to the description for the `exclude_interim` query parameter.", "x-found-in": "body" }, "expand": { "type": "boolean", "description": "Refer to the description for the `expand` query parameter.", "x-found-in": "body" }, "from": { "type": "number", "description": "Skips the specified number of buckets.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of buckets to obtain.", "x-found-in": "query" }, "sort": { "type": "string", "description": "Refer to the desription for the `sort` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "x-found-in": "body" } }, "required": ["job_id"], "description": "Get anomaly detection job results for buckets.\n\nThe API presents a chronological view of the records, grouped by bucket." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_buckets", "type": "object", "properties": { "anomaly_score": { "type": "number", "description": "Refer to the description for the `anomaly_score` query parameter.", "x-found-in": "body" }, "desc": { "type": "boolean", "description": "Refer to the description for the `desc` query parameter.", "x-found-in": "body" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `end` query parameter.", "x-found-in": "body" }, "exclude_interim": { "type": "boolean", "description": "Refer to the description for the `exclude_interim` query parameter.", "x-found-in": "body" }, "expand": { "type": "boolean", "description": "Refer to the description for the `expand` query parameter.", "x-found-in": "body" }, "from": { "type": "number", "description": "Skips the specified number of buckets.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of buckets to obtain.", "x-found-in": "query" }, "sort": { "type": "string", "description": "Refer to the desription for the `sort` query parameter.", "x-found-in": "body" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Refer to the description for the `start` query parameter.", "x-found-in": "body" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "timestamp": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "The timestamp of a single bucket result. If you do not specify this\nparameter, the API returns information about all buckets.", "x-found-in": "path" } }, "required": ["job_id"], "description": "Get anomaly detection job results for buckets.\n\nThe API presents a chronological view of the records, grouped by bucket." }

package/lib/cjs/es/json/ml.get_calendar_events.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_calendar_events", "type": "object", "properties": { "calendar_id": { "type": "string", "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.", "x-found-in": "path" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies to get events with timestamps earlier than this time.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of events.", "x-found-in": "query" }, "job_id": { "type": "string", "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 `*`.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of events to obtain.", "x-found-in": "query" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies to get events with timestamps after this time.", "x-found-in": "query" } }, "required": ["calendar_id"], "description": "Get info about events in calendars." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_calendar_events", "type": "object", "properties": { "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies to get events with timestamps earlier than this time.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of events.", "x-found-in": "query" }, "job_id": { "type": "string", "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 `*`.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of events to obtain.", "x-found-in": "query" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies to get events with timestamps after this time.", "x-found-in": "query" }, "calendar_id": { "type": "string", "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.", "x-found-in": "path" } }, "required": ["calendar_id"], "description": "Get info about events in calendars." }

package/lib/cjs/es/json/ml.get_calendars.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_calendars", "type": "object", "properties": { "calendar_id": { "type": "string", "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.", "x-found-in": "path" }, "from": { "type": "number", "description": "Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier.", "x-found-in": "query" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "description": "This object is supported only when you omit the calendar identifier.", "x-found-in": "body" } }, "description": "Get calendar configuration info." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_calendars", "type": "object", "properties": { "from": { "type": "number", "description": "Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier.", "x-found-in": "query" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "description": "This object is supported only when you omit the calendar identifier.", "x-found-in": "body" }, "calendar_id": { "type": "string", "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.", "x-found-in": "path" } }, "description": "Get calendar configuration info." }

package/lib/cjs/es/json/ml.get_categories.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_categories", "type": "object", "properties": { "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "category_id": { "type": "number", "description": "Identifier for the category, which is unique in the job. If you specify\nneither the category ID nor the partition_field_value, the API returns\ninformation about all categories. If you specify only the\npartition_field_value, it returns information about all categories for\nthe specified partition.", "x-found-in": "path" }, "from": { "type": "number", "description": "Skips the specified number of categories.", "x-found-in": "query" }, "partition_field_value": { "type": "string", "description": "Only return categories for the specified partition.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of categories to obtain.", "x-found-in": "query" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "description": "Configures pagination.\nThis parameter has the `from` and `size` properties.", "x-found-in": "body" } }, "required": ["job_id"], "description": "Get anomaly detection job results for categories." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_categories", "type": "object", "properties": { "from": { "type": "number", "description": "Skips the specified number of categories.", "x-found-in": "query" }, "partition_field_value": { "type": "string", "description": "Only return categories for the specified partition.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of categories to obtain.", "x-found-in": "query" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "description": "Configures pagination.\nThis parameter has the `from` and `size` properties.", "x-found-in": "body" }, "job_id": { "type": "string", "description": "Identifier for the anomaly detection job.", "x-found-in": "path" }, "category_id": { "type": "number", "description": "Identifier for the category, which is unique in the job. If you specify\nneither the category ID nor the partition_field_value, the API returns\ninformation about all categories. If you specify only the\npartition_field_value, it returns information about all categories for\nthe specified partition.", "x-found-in": "path" } }, "required": ["job_id"], "description": "Get anomaly detection job results for categories." }

package/lib/cjs/es/json/ml.get_data_frame_analytics.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_data_frame_analytics", "type": "object", "properties": { "id": { "type": "string", "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.", "x-found-in": "path" }, "allow_no_match": { "type": "boolean", "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.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of data frame analytics jobs.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of data frame analytics jobs to obtain.", "x-found-in": "query" }, "exclude_generated": { "type": "boolean", "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.", "x-found-in": "query" } }, "description": "Get data frame analytics job configuration info.\n\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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_data_frame_analytics", "type": "object", "properties": { "allow_no_match": { "type": "boolean", "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.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of data frame analytics jobs.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of data frame analytics jobs to obtain.", "x-found-in": "query" }, "exclude_generated": { "type": "boolean", "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.", "x-found-in": "query" }, "id": { "type": "string", "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.", "x-found-in": "path" } }, "description": "Get data frame analytics job configuration info.\n\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." }

package/lib/cjs/es/json/ml.get_data_frame_analytics_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_data_frame_analytics_stats", "type": "object", "properties": { "id": { "type": "string", "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.", "x-found-in": "path" }, "allow_no_match": { "type": "boolean", "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.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of data frame analytics jobs.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of data frame analytics jobs to obtain.", "x-found-in": "query" }, "verbose": { "type": "boolean", "description": "Defines whether the stats response should be verbose.", "x-found-in": "query" } }, "description": "Get data frame analytics job stats." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_data_frame_analytics_stats", "type": "object", "properties": { "allow_no_match": { "type": "boolean", "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.", "x-found-in": "query" }, "from": { "type": "number", "description": "Skips the specified number of data frame analytics jobs.", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies the maximum number of data frame analytics jobs to obtain.", "x-found-in": "query" }, "verbose": { "type": "boolean", "description": "Defines whether the stats response should be verbose.", "x-found-in": "query" }, "id": { "type": "string", "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.", "x-found-in": "path" } }, "description": "Get data frame analytics job stats." }

package/lib/cjs/es/json/ml.get_datafeed_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_datafeed_stats", "type": "object", "properties": { "datafeed_id": { "$ref": "./_types.json#/$defs/_types__Ids", "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.", "x-found-in": "path" }, "allow_no_match": { "type": "boolean", "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.", "x-found-in": "query" } }, "description": "Get datafeed stats.\n\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`<feed_id>`, or by omitting the `<feed_id>`. 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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_datafeed_stats", "type": "object", "properties": { "allow_no_match": { "type": "boolean", "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.", "x-found-in": "query" }, "datafeed_id": { "$ref": "./_types.json#/$defs/_types__Ids", "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.", "x-found-in": "path" } }, "description": "Get datafeed stats.\n\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`<feed_id>`, or by omitting the `<feed_id>`. 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." }