@elastic/schemas 0.4.4 → 0.4.5

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_contextualai", "type": "object", "properties": { "service": { "$ref": "./inference._types.json#/$defs/inference._types__ContextualAIServiceType", "description": "The type of service supported for the specified task type. In this case, `contextualai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ContextualAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `contextualai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ContextualAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "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" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskTypeContextualAI", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "contextualai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "contextualai_inference_id", "service", "service_settings"], "description": "Create an Contextual AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `contexualai` service.\n\nTo review the available `rerank` models, refer to <https://docs.contextual.ai/api-reference/rerank/rerank#body-model>." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_contextualai", "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" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__ContextualAIServiceType", "description": "The type of service supported for the specified task type. In this case, `contextualai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ContextualAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `contextualai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ContextualAITaskSettings", "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__TaskTypeContextualAI", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "contextualai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "contextualai_inference_id", "service", "service_settings"], "description": "Create an Contextual AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `contexualai` service.\n\nTo review the available `rerank` models, refer to <https://docs.contextual.ai/api-reference/rerank/rerank#body-model>." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_deepseek", "type": "object", "properties": { "service": { "$ref": "./inference._types.json#/$defs/inference._types__DeepSeekServiceType", "description": "The type of service supported for the specified task type. In this case, `deepseek`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__DeepSeekServiceSettings", "description": "Settings used to install the inference model.\nThese settings are specific to the `deepseek` service.", "x-found-in": "body" }, "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" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskTypeDeepSeek", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "deepseek_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "deepseek_inference_id", "service", "service_settings"], "description": "Create a DeepSeek inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `deepseek` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_deepseek", "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" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__DeepSeekServiceType", "description": "The type of service supported for the specified task type. In this case, `deepseek`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__DeepSeekServiceSettings", "description": "Settings used to install the inference model.\nThese settings are specific to the `deepseek` service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__TaskTypeDeepSeek", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "deepseek_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "deepseek_inference_id", "service", "service_settings"], "description": "Create a DeepSeek inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `deepseek` service." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_elasticsearch", "type": "object", "properties": { "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nApplies only to the `sparse_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__ElasticsearchServiceType", "description": "The type of service supported for the specified task type. In this case, `elasticsearch`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ElasticsearchServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `elasticsearch` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ElasticsearchTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "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" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__ElasticsearchTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "elasticsearch_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.\nThe must not match the `model_id`.", "x-found-in": "path" } }, "required": ["task_type", "elasticsearch_inference_id", "service", "service_settings"], "description": "Create an Elasticsearch inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elasticsearch` service.\n\n> info\n> Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings.\n\nIf you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_elasticsearch", "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 `sparse_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__ElasticsearchServiceType", "description": "The type of service supported for the specified task type. In this case, `elasticsearch`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ElasticsearchServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `elasticsearch` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ElasticsearchTaskSettings", "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__ElasticsearchTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "elasticsearch_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.\nThe must not match the `model_id`.", "x-found-in": "path" } }, "required": ["task_type", "elasticsearch_inference_id", "service", "service_settings"], "description": "Create an Elasticsearch inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elasticsearch` service.\n\n> info\n> Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings.\n\nIf you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_elser", "type": "object", "properties": { "chunking_settings": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceChunkingSettings", "description": "The chunking configuration object.\nNote that for ELSER endpoints, the max_chunk_size may not exceed `300`.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__ElserServiceType", "description": "The type of service supported for the specified task type. In this case, `elser`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ElserServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `elser` service.", "x-found-in": "body" }, "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" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__ElserTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "elser_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "elser_inference_id", "service", "service_settings"], "description": "Create an ELSER inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elser` service.\nYou can also deploy ELSER by using the Elasticsearch inference integration.\n\n> info\n> Your Elasticsearch deployment contains a preconfigured ELSER inference endpoint, you only need to create the enpoint using the API if you want to customize the settings.\n\nThe API request will automatically download and deploy the ELSER model if it isn't already downloaded.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_elser", "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.\nNote that for ELSER endpoints, the max_chunk_size may not exceed `300`.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__ElserServiceType", "description": "The type of service supported for the specified task type. In this case, `elser`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__ElserServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `elser` service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__ElserTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "elser_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "elser_inference_id", "service", "service_settings"], "description": "Create an ELSER inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elser` service.\nYou can also deploy ELSER by using the Elasticsearch inference integration.\n\n> info\n> Your Elasticsearch deployment contains a preconfigured ELSER inference endpoint, you only need to create the enpoint using the API if you want to customize the settings.\n\nThe API request will automatically download and deploy the ELSER model if it isn't already downloaded.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_fireworksai", "type": "object", "properties": { "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__FireworksAIServiceType", "description": "The type of service supported for the specified task type. In this case, `fireworksai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `fireworksai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAITaskSettings", "description": "Settings to configure the inference task.\nApplies only to the `completion` or `chat_completion` task types.\nNot applicable to the `text_embedding` task type.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "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" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "fireworksai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "fireworksai_inference_id", "service", "service_settings"], "description": "Create a Fireworks AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `fireworksai` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_fireworksai", "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__FireworksAIServiceType", "description": "The type of service supported for the specified task type. In this case, `fireworksai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `fireworksai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAITaskSettings", "description": "Settings to configure the inference task.\nApplies only to the `completion` or `chat_completion` task types.\nNot applicable to the `text_embedding` task type.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__FireworksAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "fireworksai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "fireworksai_inference_id", "service", "service_settings"], "description": "Create a Fireworks AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `fireworksai` service." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_googleaistudio", "type": "object", "properties": { "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` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleAiServiceType", "description": "The type of service supported for the specified task type. In this case, `googleaistudio`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleAiStudioServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `googleaistudio` service.", "x-found-in": "body" }, "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" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleAiStudioTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "googleaistudio_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "googleaistudio_inference_id", "service", "service_settings"], "description": "Create an Google AI Studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googleaistudio` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_googleaistudio", "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` task type.", "x-found-in": "body" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleAiServiceType", "description": "The type of service supported for the specified task type. In this case, `googleaistudio`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleAiStudioServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `googleaistudio` service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleAiStudioTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "googleaistudio_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "googleaistudio_inference_id", "service", "service_settings"], "description": "Create an Google AI Studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googleaistudio` service." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_googlevertexai", "type": "object", "properties": { "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__GoogleVertexAIServiceType", "description": "The type of service supported for the specified task type. In this case, `googlevertexai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleVertexAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `googlevertexai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleVertexAITaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "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" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleVertexAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "googlevertexai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "googlevertexai_inference_id", "service", "service_settings"], "description": "Create a Google Vertex AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googlevertexai` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_googlevertexai", "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__GoogleVertexAIServiceType", "description": "The type of service supported for the specified task type. In this case, `googlevertexai`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleVertexAIServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `googlevertexai` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GoogleVertexAITaskSettings", "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__GoogleVertexAITaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "googlevertexai_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "googlevertexai_inference_id", "service", "service_settings"], "description": "Create a Google Vertex AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googlevertexai` service." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_groq", "type": "object", "properties": { "service": { "$ref": "./inference._types.json#/$defs/inference._types__GroqServiceType", "description": "The type of service supported for the specified task type. In this case, `groq`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GroqServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `groq` service.", "x-found-in": "body" }, "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" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__GroqTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "groq_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "groq_inference_id", "service", "service_settings"], "description": "Create a Groq inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `groq` service." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_groq", "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" }, "service": { "$ref": "./inference._types.json#/$defs/inference._types__GroqServiceType", "description": "The type of service supported for the specified task type. In this case, `groq`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__GroqServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `groq` service.", "x-found-in": "body" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__GroqTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "groq_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "groq_inference_id", "service", "service_settings"], "description": "Create a Groq inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `groq` service." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_hugging_face", "type": "object", "properties": { "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__HuggingFaceServiceType", "description": "The type of service supported for the specified task type. In this case, `hugging_face`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__HuggingFaceServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `hugging_face` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__HuggingFaceTaskSettings", "description": "Settings to configure the inference task.\nThese settings are specific to the task type you specified.", "x-found-in": "body" }, "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" }, "task_type": { "$ref": "./inference._types.json#/$defs/inference._types__HuggingFaceTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "huggingface_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "huggingface_inference_id", "service", "service_settings"], "description": "Create a Hugging Face inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `hugging_face` service.\nSupported tasks include: `text_embedding`, `completion`, and `chat_completion`.\n\nTo configure the endpoint, first visit the Hugging Face Inference Endpoints page and create a new endpoint.\nSelect a model that supports the task you intend to use.\n\nFor Elastic's `text_embedding` task:\nThe selected model must support the `Sentence Embeddings` task. On the new endpoint creation page, select the `Sentence Embeddings` task under the `Advanced Configuration` section.\nAfter the endpoint has initialized, copy the generated endpoint URL.\nRecommended models for `text_embedding` task:\n\n* `all-MiniLM-L6-v2`\n* `all-MiniLM-L12-v2`\n* `all-mpnet-base-v2`\n* `e5-base-v2`\n* `e5-small-v2`\n* `multilingual-e5-base`\n* `multilingual-e5-small`\n\nFor Elastic's `chat_completion` and `completion` tasks:\nThe selected model must support the `Text Generation` task and expose OpenAI API. HuggingFace supports both serverless and dedicated endpoints for `Text Generation`. When creating dedicated endpoint select the `Text Generation` task.\nAfter the endpoint is initialized (for dedicated) or ready (for serverless), ensure it supports the OpenAI API and includes `/v1/chat/completions` part in URL. Then, copy the full endpoint URL for use.\nRecommended models for `chat_completion` and `completion` tasks:\n\n* `Mistral-7B-Instruct-v0.2`\n* `QwQ-32B`\n* `Phi-3-mini-128k-instruct`\n\nFor Elastic's `rerank` task:\nThe selected model must support the `sentence-ranking` task and expose OpenAI API.\nHuggingFace supports only dedicated (not serverless) endpoints for `Rerank` so far.\nAfter the endpoint is initialized, copy the full endpoint URL for use.\nTested models for `rerank` task:\n\n* `bge-reranker-base`\n* `jina-reranker-v1-turbo-en-GGUF`" }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_hugging_face", "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__HuggingFaceServiceType", "description": "The type of service supported for the specified task type. In this case, `hugging_face`.", "x-found-in": "body" }, "service_settings": { "$ref": "./inference._types.json#/$defs/inference._types__HuggingFaceServiceSettings", "description": "Settings used to install the inference model. These settings are specific to the `hugging_face` service.", "x-found-in": "body" }, "task_settings": { "$ref": "./inference._types.json#/$defs/inference._types__HuggingFaceTaskSettings", "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__HuggingFaceTaskType", "description": "The type of the inference task that the model will perform.", "x-found-in": "path" }, "huggingface_inference_id": { "type": "string", "description": "The unique identifier of the inference endpoint.", "x-found-in": "path" } }, "required": ["task_type", "huggingface_inference_id", "service", "service_settings"], "description": "Create a Hugging Face inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `hugging_face` service.\nSupported tasks include: `text_embedding`, `completion`, and `chat_completion`.\n\nTo configure the endpoint, first visit the Hugging Face Inference Endpoints page and create a new endpoint.\nSelect a model that supports the task you intend to use.\n\nFor Elastic's `text_embedding` task:\nThe selected model must support the `Sentence Embeddings` task. On the new endpoint creation page, select the `Sentence Embeddings` task under the `Advanced Configuration` section.\nAfter the endpoint has initialized, copy the generated endpoint URL.\nRecommended models for `text_embedding` task:\n\n* `all-MiniLM-L6-v2`\n* `all-MiniLM-L12-v2`\n* `all-mpnet-base-v2`\n* `e5-base-v2`\n* `e5-small-v2`\n* `multilingual-e5-base`\n* `multilingual-e5-small`\n\nFor Elastic's `chat_completion` and `completion` tasks:\nThe selected model must support the `Text Generation` task and expose OpenAI API. HuggingFace supports both serverless and dedicated endpoints for `Text Generation`. When creating dedicated endpoint select the `Text Generation` task.\nAfter the endpoint is initialized (for dedicated) or ready (for serverless), ensure it supports the OpenAI API and includes `/v1/chat/completions` part in URL. Then, copy the full endpoint URL for use.\nRecommended models for `chat_completion` and `completion` tasks:\n\n* `Mistral-7B-Instruct-v0.2`\n* `QwQ-32B`\n* `Phi-3-mini-128k-instruct`\n\nFor Elastic's `rerank` task:\nThe selected model must support the `sentence-ranking` task and expose OpenAI API.\nHuggingFace supports only dedicated (not serverless) endpoints for `Rerank` so far.\nAfter the endpoint is initialized, copy the full endpoint URL for use.\nTested models for `rerank` task:\n\n* `bge-reranker-base`\n* `jina-reranker-v1-turbo-en-GGUF`" }

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": { "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" }, "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" }, "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/>." }
+{ "$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": { "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" }, "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" }, "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." }
+{ "$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": { "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" }, "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" }, "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." }
+{ "$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": { "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" }, "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" }, "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." }
+{ "$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": { "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" }, "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" }, "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." }
+{ "$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": { "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" }, "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" }, "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." }
+{ "$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_region_policy.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_region_policy", "type": "object", "properties": { "region_policy": { "$ref": "./inference._types.json#/$defs/inference._types__RegionPolicy", "description": "The region policy configuration.", "x-found-in": "body" }, "force": { "type": "boolean", "description": "If `true`, the region policy is applied even if it would deny access to inference endpoints that are currently in use by ingest pipeline or indices.", "x-found-in": "query" } }, "required": ["region_policy"], "description": "Create or update the inference region policy.\n\nThe region policy restricts inference to a set of allowed geographic areas or cloud service provider regions." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_region_policy", "type": "object", "properties": { "force": { "type": "boolean", "description": "If `true`, the region policy is applied even if it would deny access to inference endpoints that are currently in use by ingest pipeline or indices.", "x-found-in": "query" }, "region_policy": { "$ref": "./inference._types.json#/$defs/inference._types__RegionPolicy", "description": "The region policy configuration.", "x-found-in": "body" } }, "required": ["region_policy"], "description": "Create or update the inference region policy.\n\nThe region policy restricts inference to a set of allowed geographic areas or cloud service provider regions." }

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": { "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" }, "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" }, "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." }
+{ "$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": { "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" }, "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" }, "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." }
+{ "$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": { "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" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "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." }
+{ "$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": { "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" }, "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" }, "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" } }, "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": { "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" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The amount of time to wait for the inference request to complete.", "x-found-in": "query" }, "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." }
+{ "$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": { "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" }, "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" }, "inference_id": { "type": "string", "description": "The inference Id", "x-found-in": "path" } }, "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": { "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_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." }
+{ "$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.put_geoip_database.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.put_geoip_database", "type": "object", "properties": { "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" }, "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" }, "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." }
+{ "$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": { "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" }, "id": { "type": "string", "description": "The database configuration identifier.", "x-found-in": "path" } }, "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": { "_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" }, "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" }, "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." }
+{ "$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": { "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" }, "verbose": { "type": "boolean", "description": "If `true`, the response includes output data for each processor in the executed pipeline.", "x-found-in": "query" }, "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." }
+{ "$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/license.post.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "license.post", "type": "object", "properties": { "license": { "$ref": "./license._types.json#/$defs/license._types__License", "x-found-in": "body" }, "licenses": { "type": "array", "items": { "$ref": "./license._types.json#/$defs/license._types__License" }, "description": "A sequence of one or more JSON documents containing the license information.", "x-found-in": "body" }, "acknowledge": { "type": "boolean", "description": "To update a license, you must accept the acknowledge messages and set this parameter to `true`.\nIn particular, if you are upgrading or downgrading a license, you must acknowlege the feature changes.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "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" } }, "description": "Update the license.\n\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "license.post", "type": "object", "properties": { "acknowledge": { "type": "boolean", "description": "To update a license, you must accept the acknowledge messages and set this parameter to `true`.\nIn particular, if you are upgrading or downgrading a license, you must acknowlege the feature changes.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "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" }, "license": { "$ref": "./license._types.json#/$defs/license._types__License", "x-found-in": "body" }, "licenses": { "type": "array", "items": { "$ref": "./license._types.json#/$defs/license._types__License" }, "description": "A sequence of one or more JSON documents containing the license information.", "x-found-in": "body" } }, "description": "Update the license.\n\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API." }

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": { "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" }, "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" }, "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." }
+{ "$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": { "allow_no_match": { "type": "boolean", "description": "Specifies what to do when the request: contains wildcard expressions and there are no jobs that match; contains the  `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty jobs array when there are no matches and the subset of results when there are partial matches.\nIf `false`, the request returns a 404 status code when there are no matches or only partial matches.", "x-found-in": "query" }, "force": { "type": "boolean", "description": "Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots.\nIf you want the job to be in a consistent state after the close job API returns, do not set to `true`. This parameter should be used only in situations where the job has already failed or where you are not interested in results the job might have recently produced or might produce in the future.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Controls the time to wait until a job has closed.", "x-found-in": "query" }, "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." }
+{ "$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_expired_data.request.json

@@ -1 +1 @@
-{ "$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": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "How long can the underlying delete processes run until they are canceled.", "x-found-in": "query" }, "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>`." }
+{ "$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.flush_job.request.json

@@ -1 +1 @@
-{ "$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": "Specifies to advance to a particular time value. Results are generated\nand the model is updated for data from the specified time interval.", "x-found-in": "query" }, "calc_interim": { "type": "boolean", "description": "If true, calculates the interim results for the most recent bucket or all\nbuckets within the latency period.", "x-found-in": "query" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "When used in conjunction with `calc_interim` and `start`, specifies the\nrange of buckets on which to calculate interim results.", "x-found-in": "query" }, "skip_time": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Specifies to skip to a particular time value. Results are not generated\nand the model is not updated for data from the specified time interval.", "x-found-in": "query" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "When used in conjunction with `calc_interim`, specifies the range of\nbuckets on which to calculate interim results.", "x-found-in": "query" }, "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." }
+{ "$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": { "duration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "A period of time that indicates how far into the future to forecast. For\nexample, `30d` corresponds to 30 days. The forecast starts at the last\nrecord that was processed.", "x-found-in": "query" }, "expires_in": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period of time that forecast results are retained. After a forecast\nexpires, the results are deleted. If set to a value of 0, the forecast is\nnever automatically deleted.", "x-found-in": "query" }, "max_model_memory": { "type": "string", "description": "The maximum memory the forecast can use. If the forecast needs to use\nmore than the provided amount, it will spool to disk. Default is 20mb,\nmaximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s\nconfigured memory limit, it is automatically reduced to below that\namount.", "x-found-in": "query" }, "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." }
+{ "$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": { "anomaly_score": { "type": "number", "description": "Returns buckets with anomaly scores greater or equal than this value.", "x-found-in": "query" }, "desc": { "type": "boolean", "description": "If `true`, the buckets are sorted in descending order.", "x-found-in": "query" }, "end": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Returns buckets with timestamps earlier than this time. `-1` means it is\nunset and results are not limited to specific timestamps.", "x-found-in": "query" }, "exclude_interim": { "type": "boolean", "description": "If `true`, the output excludes interim results.", "x-found-in": "query" }, "expand": { "type": "boolean", "description": "If true, the output includes anomaly records.", "x-found-in": "query" }, "page": { "$ref": "./ml._types.json#/$defs/ml._types__Page", "x-found-in": "body" }, "sort": { "type": "string", "description": "Specifies the sort field for the requested buckets.", "x-found-in": "query" }, "start": { "$ref": "./_types.json#/$defs/_types__DateTime", "description": "Returns buckets with timestamps after this time. `-1` means it is unset\nand results are not limited to specific timestamps.", "x-found-in": "query" }, "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" }, "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." }
+{ "$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_calendars.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ml.get_calendars", "type": "object", "properties": { "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" }, "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" }, "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." }
+{ "$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." }