@elastic/schemas 0.5.1 → 0.6.0

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", "description": "Create a Fireworks AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `fireworksai` service.", "x-api": { "id": "inference.put_fireworksai", "name": "put-fireworksai", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{fireworksai_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{fireworksai_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.4.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_fireworksai", "description": "Create a Fireworks AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `fireworksai` service.", "x-api": { "id": "inference.put_fireworksai", "name": "put-fireworksai", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{fireworksai_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{fireworksai_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.4.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "fireworksai_inference_id", "service", "service_settings"] }

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", "description": "Create an Google AI Studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googleaistudio` service.", "x-api": { "id": "inference.put_googleaistudio", "name": "put-googleaistudio", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{googleaistudio_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{googleaistudio_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_googleaistudio", "description": "Create an Google AI Studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googleaistudio` service.", "x-api": { "id": "inference.put_googleaistudio", "name": "put-googleaistudio", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{googleaistudio_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{googleaistudio_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "googleaistudio_inference_id", "service", "service_settings"] }

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", "description": "Create a Google Vertex AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googlevertexai` service.", "x-api": { "id": "inference.put_googlevertexai", "name": "put-googlevertexai", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{googlevertexai_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{googlevertexai_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_googlevertexai", "description": "Create a Google Vertex AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googlevertexai` service.", "x-api": { "id": "inference.put_googlevertexai", "name": "put-googlevertexai", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{googlevertexai_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{googlevertexai_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "googlevertexai_inference_id", "service", "service_settings"] }

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", "description": "Create a Groq inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `groq` service.", "x-api": { "id": "inference.put_groq", "name": "put-groq", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{groq_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{groq_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.3.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_groq", "description": "Create a Groq inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `groq` service.", "x-api": { "id": "inference.put_groq", "name": "put-groq", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{groq_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{groq_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.3.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "groq_inference_id", "service", "service_settings"] }

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", "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`", "x-api": { "id": "inference.put_hugging_face", "name": "put-hugging-face", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{huggingface_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{huggingface_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_hugging_face", "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`", "x-api": { "id": "inference.put_hugging_face", "name": "put-hugging-face", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{huggingface_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{huggingface_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "huggingface_inference_id", "service", "service_settings"] }

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", "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/>.", "x-api": { "id": "inference.put_jinaai", "name": "put-jinaai", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{jinaai_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{jinaai_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.18.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_jinaai", "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/>.", "x-api": { "id": "inference.put_jinaai", "name": "put-jinaai", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{jinaai_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{jinaai_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.18.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "jinaai_inference_id", "service", "service_settings"] }

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", "description": "Create a Llama inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `llama` service.", "x-api": { "id": "inference.put_llama", "name": "put-llama", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{llama_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{llama_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.2.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_llama", "description": "Create a Llama inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `llama` service.", "x-api": { "id": "inference.put_llama", "name": "put-llama", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{llama_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{llama_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.2.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "llama_inference_id", "service", "service_settings"] }

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", "description": "Create a Mistral inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `mistral` service.", "x-api": { "id": "inference.put_mistral", "name": "put-mistral", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{mistral_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{mistral_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_mistral", "description": "Create a Mistral inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `mistral` service.", "x-api": { "id": "inference.put_mistral", "name": "put-mistral", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{mistral_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{mistral_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "mistral_inference_id", "service", "service_settings"] }

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", "description": "Create an Nvidia inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `nvidia` service.", "x-api": { "id": "inference.put_nvidia", "name": "put-nvidia", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{nvidia_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{nvidia_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.3.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_nvidia", "description": "Create an Nvidia inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `nvidia` service.", "x-api": { "id": "inference.put_nvidia", "name": "put-nvidia", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{nvidia_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{nvidia_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.3.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "nvidia_inference_id", "service", "service_settings"] }

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", "description": "Create an OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs.", "x-api": { "id": "inference.put_openai", "name": "put-openai", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{openai_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{openai_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_openai", "description": "Create an OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs.", "x-api": { "id": "inference.put_openai", "name": "put-openai", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{openai_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{openai_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "openai_inference_id", "service", "service_settings"] }

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", "description": "Create an OpenShift AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openshift_ai` service.", "x-api": { "id": "inference.put_openshift_ai", "name": "put-openshift-ai", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{openshiftai_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{openshiftai_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.3.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_openshift_ai", "description": "Create an OpenShift AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openshift_ai` service.", "x-api": { "id": "inference.put_openshift_ai", "name": "put-openshift-ai", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{openshiftai_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{openshiftai_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.3.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "openshiftai_inference_id", "service", "service_settings"] }

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", "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.", "x-api": { "id": "inference.put_region_policy", "name": "put-region-policy", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/_region_policy", "x-urls": [{ "path": "/_inference/_region_policy", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.5.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_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.", "x-api": { "id": "inference.put_region_policy", "name": "put-region-policy", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/_region_policy", "x-urls": [{ "path": "/_inference/_region_policy", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.5.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["region_policy"] }

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", "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.", "x-api": { "id": "inference.put_voyageai", "name": "put-voyageai", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{voyageai_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{voyageai_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.19.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_voyageai", "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.", "x-api": { "id": "inference.put_voyageai", "name": "put-voyageai", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{voyageai_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{voyageai_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.19.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "voyageai_inference_id", "service", "service_settings"] }

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", "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.", "x-api": { "id": "inference.put_watsonx", "name": "put-watsonx", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{watsonx_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{watsonx_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.16.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.put_watsonx", "description": "Create a Watsonx inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `watsonxai` service.\nYou need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service.\nYou can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.", "x-api": { "id": "inference.put_watsonx", "name": "put-watsonx", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{watsonx_inference_id}", "x-urls": [{ "path": "/_inference/{task_type}/{watsonx_inference_id}", "methods": ["PUT"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.16.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["task_type", "watsonx_inference_id", "service", "service_settings"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.rerank", "description": "Perform reranking inference on the service.", "x-api": { "id": "inference.rerank", "name": "rerank", "namespace": "inference" }, "x-method": "POST", "x-path": "/_inference/rerank/{inference_id}", "x-urls": [{ "path": "/_inference/rerank/{inference_id}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.11.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.rerank", "description": "Perform reranking inference on the service.", "x-api": { "id": "inference.rerank", "name": "rerank", "namespace": "inference" }, "x-method": "POST", "x-path": "/_inference/rerank/{inference_id}", "x-urls": [{ "path": "/_inference/rerank/{inference_id}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.11.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["inference_id", "query", "input"] }

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", "description": "Perform sparse embedding inference on the service.", "x-api": { "id": "inference.sparse_embedding", "name": "sparse-embedding", "namespace": "inference" }, "x-method": "POST", "x-path": "/_inference/sparse_embedding/{inference_id}", "x-urls": [{ "path": "/_inference/sparse_embedding/{inference_id}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.11.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.sparse_embedding", "description": "Perform sparse embedding inference on the service.", "x-api": { "id": "inference.sparse_embedding", "name": "sparse-embedding", "namespace": "inference" }, "x-method": "POST", "x-path": "/_inference/sparse_embedding/{inference_id}", "x-urls": [{ "path": "/_inference/sparse_embedding/{inference_id}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.11.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["inference_id", "input"] }

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", "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.", "x-api": { "id": "inference.stream_completion", "name": "stream-completion", "namespace": "inference" }, "x-method": "POST", "x-path": "/_inference/completion/{inference_id}/_stream", "x-urls": [{ "path": "/_inference/completion/{inference_id}/_stream", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.16.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.stream_completion", "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.", "x-api": { "id": "inference.stream_completion", "name": "stream-completion", "namespace": "inference" }, "x-method": "POST", "x-path": "/_inference/completion/{inference_id}/_stream", "x-urls": [{ "path": "/_inference/completion/{inference_id}/_stream", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.16.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "x-response-type": ["text/event-stream"], "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["inference_id", "input"] }

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", "description": "Perform text embedding inference on the service.", "x-api": { "id": "inference.text_embedding", "name": "text-embedding", "namespace": "inference" }, "x-method": "POST", "x-path": "/_inference/text_embedding/{inference_id}", "x-urls": [{ "path": "/_inference/text_embedding/{inference_id}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.11.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.text_embedding", "description": "Perform text embedding inference on the service.", "x-api": { "id": "inference.text_embedding", "name": "text-embedding", "namespace": "inference" }, "x-method": "POST", "x-path": "/_inference/text_embedding/{inference_id}", "x-urls": [{ "path": "/_inference/text_embedding/{inference_id}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.11.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["inference_id", "input"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.update", "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.", "x-api": { "id": "inference.update", "name": "update", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{inference_id}/_update", "x-urls": [{ "path": "/_inference/{inference_id}/_update", "methods": ["PUT"] }, { "path": "/_inference/{task_type}/{inference_id}/_update", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.17.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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", "x-availability": { "stack": { "since": "9.5.0" }, "serverless": {} } }, "inference_config": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceEndpoint", "x-found-in": "body", "x-body-root": true }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "inference.update", "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.", "x-api": { "id": "inference.update", "name": "update", "namespace": "inference" }, "x-method": "PUT", "x-path": "/_inference/{task_type}/{inference_id}/_update", "x-urls": [{ "path": "/_inference/{inference_id}/_update", "methods": ["PUT"] }, { "path": "/_inference/{task_type}/{inference_id}/_update", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.17.0", "stability": "stable", "visibility": "public" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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", "x-availability": { "stack": { "since": "9.5.0" }, "serverless": {} } }, "inference_config": { "$ref": "./inference._types.json#/$defs/inference._types__InferenceEndpoint", "x-found-in": "body", "x-body-root": true }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["inference_id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "info", "description": "Get cluster info.\n\nGet basic build, version, and cluster information.\n::: In Serverless, `version.number` always reports the next target Elasticsearch release version at the time of the request. Serverless does not track to a traditional release versioning model; it is continuously updated. The version number is provided to maintain compatibility with existing clients, but it is not meaningful for assessing feature availability. Clients should detect a Serverless environment by checking for `build_flavor: serverless`.", "x-api": { "id": "info", "name": "info", "namespace": null }, "x-method": "GET", "x-path": "/", "x-urls": [{ "path": "/", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": {} }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "info", "description": "Get cluster info.\n\nGet basic build, version, and cluster information.\n::: In Serverless, `version.number` always reports the next target Elasticsearch release version at the time of the request. Serverless does not track to a traditional release versioning model; it is continuously updated. The version number is provided to maintain compatibility with existing clients, but it is not meaningful for assessing feature availability. Clients should detect a Serverless environment by checking for `build_flavor: serverless`.", "x-api": { "id": "info", "name": "info", "namespace": null }, "x-method": "GET", "x-path": "/", "x-urls": [{ "path": "/", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.delete_geoip_database", "description": "Delete GeoIP database configurations.\n\nDelete one or more IP geolocation database configurations.", "x-api": { "id": "ingest.delete_geoip_database", "name": "delete-geoip-database", "namespace": "ingest" }, "x-method": "DELETE", "x-path": "/_ingest/geoip/database/{id}", "x-urls": [{ "path": "/_ingest/geoip/database/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable" }, "serverless": { "visibility": "private" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A comma-separated list of geoip database configurations to delete", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.delete_geoip_database", "description": "Delete GeoIP database configurations.\n\nDelete one or more IP geolocation database configurations.", "x-api": { "id": "ingest.delete_geoip_database", "name": "delete-geoip-database", "namespace": "ingest" }, "x-method": "DELETE", "x-path": "/_ingest/geoip/database/{id}", "x-urls": [{ "path": "/_ingest/geoip/database/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable" }, "serverless": { "visibility": "private" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A comma-separated list of geoip database configurations to delete", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.delete_ip_location_database", "description": "Delete IP geolocation database configurations.", "x-api": { "id": "ingest.delete_ip_location_database", "name": "delete-ip-location-database", "namespace": "ingest" }, "x-method": "DELETE", "x-path": "/_ingest/ip_location/database/{id}", "x-urls": [{ "path": "/_ingest/ip_location/database/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable" }, "serverless": { "visibility": "private" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A comma-separated list of IP location database configurations.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.delete_ip_location_database", "description": "Delete IP geolocation database configurations.", "x-api": { "id": "ingest.delete_ip_location_database", "name": "delete-ip-location-database", "namespace": "ingest" }, "x-method": "DELETE", "x-path": "/_ingest/ip_location/database/{id}", "x-urls": [{ "path": "/_ingest/ip_location/database/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable" }, "serverless": { "visibility": "private" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "x-found-in": "query" }, "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A comma-separated list of IP location database configurations.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.delete_pipeline", "description": "Delete pipelines.\n\nDelete one or more ingest pipelines.", "x-api": { "id": "ingest.delete_pipeline", "name": "delete-pipeline", "namespace": "ingest" }, "x-method": "DELETE", "x-path": "/_ingest/pipeline/{id}", "x-urls": [{ "path": "/_ingest/pipeline/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "id": { "type": "string", "description": "Pipeline ID or wildcard expression of pipeline IDs used to limit the request.\nTo delete all ingest pipelines in a cluster, use a value of `*`.", "x-found-in": "path" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.delete_pipeline", "description": "Delete pipelines.\n\nDelete one or more ingest pipelines.", "x-api": { "id": "ingest.delete_pipeline", "name": "delete-pipeline", "namespace": "ingest" }, "x-method": "DELETE", "x-path": "/_ingest/pipeline/{id}", "x-urls": [{ "path": "/_ingest/pipeline/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "id": { "type": "string", "description": "Pipeline ID or wildcard expression of pipeline IDs used to limit the request.\nTo delete all ingest pipelines in a cluster, use a value of `*`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.geo_ip_stats", "description": "Get GeoIP statistics.\n\nGet download statistics for GeoIP2 databases that are used with the GeoIP processor.", "x-api": { "id": "ingest.geo_ip_stats", "name": "geo-ip-stats", "namespace": "ingest" }, "x-method": "GET", "x-path": "/_ingest/geoip/stats", "x-urls": [{ "path": "/_ingest/geoip/stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.13.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": {} }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.geo_ip_stats", "description": "Get GeoIP statistics.\n\nGet download statistics for GeoIP2 databases that are used with the GeoIP processor.", "x-api": { "id": "ingest.geo_ip_stats", "name": "geo-ip-stats", "namespace": "ingest" }, "x-method": "GET", "x-path": "/_ingest/geoip/stats", "x-urls": [{ "path": "/_ingest/geoip/stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.13.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.get_geoip_database", "description": "Get GeoIP database configurations.\n\nGet information about one or more IP geolocation database configurations.", "x-api": { "id": "ingest.get_geoip_database", "name": "get-geoip-database", "namespace": "ingest" }, "x-method": "GET", "x-path": "/_ingest/geoip/database/{id}", "x-urls": [{ "path": "/_ingest/geoip/database", "methods": ["GET"] }, { "path": "/_ingest/geoip/database/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable" }, "serverless": { "visibility": "private" } }, "type": "object", "properties": { "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A comma-separated list of database configuration IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all database configurations, omit this parameter or use `*`.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.get_geoip_database", "description": "Get GeoIP database configurations.\n\nGet information about one or more IP geolocation database configurations.", "x-api": { "id": "ingest.get_geoip_database", "name": "get-geoip-database", "namespace": "ingest" }, "x-method": "GET", "x-path": "/_ingest/geoip/database/{id}", "x-urls": [{ "path": "/_ingest/geoip/database", "methods": ["GET"] }, { "path": "/_ingest/geoip/database/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable" }, "serverless": { "visibility": "private" } }, "type": "object", "properties": { "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "A comma-separated list of database configuration IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all database configurations, omit this parameter or use `*`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.get_ip_location_database", "description": "Get IP geolocation database configurations.", "x-api": { "id": "ingest.get_ip_location_database", "name": "get-ip-location-database", "namespace": "ingest" }, "x-method": "GET", "x-path": "/_ingest/ip_location/database/{id}", "x-urls": [{ "path": "/_ingest/ip_location/database", "methods": ["GET"] }, { "path": "/_ingest/ip_location/database/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable" }, "serverless": { "visibility": "private" } }, "type": "object", "properties": { "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "Comma-separated list of database configuration IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all database configurations, omit this parameter or use `*`.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.get_ip_location_database", "description": "Get IP geolocation database configurations.", "x-api": { "id": "ingest.get_ip_location_database", "name": "get-ip-location-database", "namespace": "ingest" }, "x-method": "GET", "x-path": "/_ingest/ip_location/database/{id}", "x-urls": [{ "path": "/_ingest/ip_location/database", "methods": ["GET"] }, { "path": "/_ingest/ip_location/database/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.15.0", "stability": "stable" }, "serverless": { "visibility": "private" } }, "type": "object", "properties": { "id": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "Comma-separated list of database configuration IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all database configurations, omit this parameter or use `*`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.get_pipeline", "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "x-api": { "id": "ingest.get_pipeline", "name": "get-pipeline", "namespace": "ingest" }, "x-method": "GET", "x-path": "/_ingest/pipeline/{id}", "x-urls": [{ "path": "/_ingest/pipeline", "methods": ["GET"] }, { "path": "/_ingest/pipeline/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "summary": { "type": "boolean", "description": "Return pipelines without their definitions", "x-found-in": "query" }, "id": { "type": "string", "description": "Comma-separated list of pipeline IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all ingest pipelines, omit this parameter or use `*`.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.get_pipeline", "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "x-api": { "id": "ingest.get_pipeline", "name": "get-pipeline", "namespace": "ingest" }, "x-method": "GET", "x-path": "/_ingest/pipeline/{id}", "x-urls": [{ "path": "/_ingest/pipeline", "methods": ["GET"] }, { "path": "/_ingest/pipeline/{id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "summary": { "type": "boolean", "description": "Return pipelines without their definitions", "x-found-in": "query" }, "id": { "type": "string", "description": "Comma-separated list of pipeline IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all ingest pipelines, omit this parameter or use `*`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.processor_grok", "description": "Run a grok processor.\n\nExtract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "x-api": { "id": "ingest.processor_grok", "name": "processor-grok", "namespace": "ingest" }, "x-method": "GET", "x-path": "/_ingest/processor/grok", "x-urls": [{ "path": "/_ingest/processor/grok", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.1.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": {} }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ingest.processor_grok", "description": "Run a grok processor.\n\nExtract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "x-api": { "id": "ingest.processor_grok", "name": "processor-grok", "namespace": "ingest" }, "x-method": "GET", "x-path": "/_ingest/processor/grok", "x-urls": [{ "path": "/_ingest/processor/grok", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.1.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }