From 76d556619fd00e032e64e2cb86e16faaf73a486c Mon Sep 17 00:00:00 2001 From: pquentin <42327+pquentin@users.noreply.github.com> Date: Sat, 22 Mar 2025 04:06:40 +0000 Subject: [PATCH] Update rest-api-spec --- output/schema/schema.json | 336 ++++++++++++++++++ output/schema/validation-errors.json | 72 ++++ .../inference.put_alibabacloud.json | 35 ++ .../inference.put_amazonbedrock.json | 35 ++ .../_json_spec/inference.put_anthropic.json | 35 ++ .../inference.put_azureaistudio.json | 35 ++ .../_json_spec/inference.put_azureopenai.json | 35 ++ .../_json_spec/inference.put_cohere.json | 35 ++ .../inference.put_elasticsearch.json | 35 ++ .../_json_spec/inference.put_elser.json | 39 ++ .../inference.put_googleaistudio.json | 35 ++ .../inference.put_googlevertexai.json | 35 ++ .../inference.put_hugging_face.json | 35 ++ .../_json_spec/inference.put_jinaai.json | 35 ++ 14 files changed, 832 insertions(+) create mode 100644 specification/_json_spec/inference.put_alibabacloud.json create mode 100644 specification/_json_spec/inference.put_amazonbedrock.json create mode 100644 specification/_json_spec/inference.put_anthropic.json create mode 100644 specification/_json_spec/inference.put_azureaistudio.json create mode 100644 specification/_json_spec/inference.put_azureopenai.json create mode 100644 specification/_json_spec/inference.put_cohere.json create mode 100644 specification/_json_spec/inference.put_elasticsearch.json create mode 100644 specification/_json_spec/inference.put_elser.json create mode 100644 specification/_json_spec/inference.put_googleaistudio.json create mode 100644 specification/_json_spec/inference.put_googlevertexai.json create mode 100644 specification/_json_spec/inference.put_hugging_face.json create mode 100644 specification/_json_spec/inference.put_jinaai.json diff --git a/output/schema/schema.json b/output/schema/schema.json index 8bf3d8cd32..3eb18c2e0d 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -9306,6 +9306,174 @@ } ] }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Configure an AlibabaCloud AI Search inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-alibabacloud-ai-search.html", + "name": "inference.put_alibabacloud", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{alibabacloud_inference_id}" + } + ] + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Configure an Amazon Bedrock inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-amazon-bedrock.html", + "name": "inference.put_amazonbedrock", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{amazonbedrock_inference_id}" + } + ] + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Configure an Anthropic inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-anthropic.html", + "name": "inference.put_anthropic", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{anthropic_inference_id}" + } + ] + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Configure an Azure AI Studio inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-azure-ai-studio.html", + "name": "inference.put_azureaistudio", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{azureaistudio_inference_id}" + } + ] + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Configure an Azure OpenAI inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-azure-openai.html", + "name": "inference.put_azureopenai", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{azureopenai_inference_id}" + } + ] + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Configure a Cohere inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-cohere.html", + "name": "inference.put_cohere", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{cohere_inference_id}" + } + ] + }, { "availability": { "serverless": { @@ -9351,6 +9519,174 @@ } ] }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Configure an Elasticsearch inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elasticsearch.html", + "name": "inference.put_elasticsearch", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{elasticsearch_inference_id}" + } + ] + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Configure an ELSER inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elser.html", + "name": "inference.put_elser", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{elser_inference_id}" + } + ] + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Configure a Google AI Studio inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-google-ai-studio.html", + "name": "inference.put_googleaistudio", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{googleaistudio_inference_id}" + } + ] + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Configure a Google Vertex AI inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-google-vertex-ai.html", + "name": "inference.put_googlevertexai", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{googlevertexai_inference_id}" + } + ] + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Configure a HuggingFace inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-hugging-face.html", + "name": "inference.put_hugging_face", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{huggingface_inference_id}" + } + ] + }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Configure a JinaAI inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-jinaai.html", + "name": "inference.put_jinaai", + "request": null, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_inference/{task_type}/{jinaai_inference_id}" + } + ] + }, { "availability": { "stack": { diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 89afa97b85..25ffed7763 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -303,6 +303,78 @@ ], "response": [] }, + "inference.put_alibabacloud": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.put_amazonbedrock": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.put_anthropic": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.put_azureaistudio": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.put_azureopenai": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.put_cohere": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.put_elasticsearch": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.put_elser": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.put_googleaistudio": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.put_googlevertexai": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.put_hugging_face": { + "request": [ + "Missing request & response" + ], + "response": [] + }, + "inference.put_jinaai": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "inference.put_mistral": { "request": [ "Missing request & response" diff --git a/specification/_json_spec/inference.put_alibabacloud.json b/specification/_json_spec/inference.put_alibabacloud.json new file mode 100644 index 0000000000..b39d5abe97 --- /dev/null +++ b/specification/_json_spec/inference.put_alibabacloud.json @@ -0,0 +1,35 @@ +{ + "inference.put_alibabacloud": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-alibabacloud-ai-search.html", + "description": "Configure an AlibabaCloud AI Search inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{alibabacloud_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "alibabacloud_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +} diff --git a/specification/_json_spec/inference.put_amazonbedrock.json b/specification/_json_spec/inference.put_amazonbedrock.json new file mode 100644 index 0000000000..266a1800a3 --- /dev/null +++ b/specification/_json_spec/inference.put_amazonbedrock.json @@ -0,0 +1,35 @@ +{ + "inference.put_amazonbedrock": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-amazon-bedrock.html", + "description": "Configure an Amazon Bedrock inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{amazonbedrock_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "amazonbedrock_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +} diff --git a/specification/_json_spec/inference.put_anthropic.json b/specification/_json_spec/inference.put_anthropic.json new file mode 100644 index 0000000000..dce56157c7 --- /dev/null +++ b/specification/_json_spec/inference.put_anthropic.json @@ -0,0 +1,35 @@ +{ + "inference.put_anthropic": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-anthropic.html", + "description": "Configure an Anthropic inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{anthropic_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "anthropic_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +} diff --git a/specification/_json_spec/inference.put_azureaistudio.json b/specification/_json_spec/inference.put_azureaistudio.json new file mode 100644 index 0000000000..00de83eca7 --- /dev/null +++ b/specification/_json_spec/inference.put_azureaistudio.json @@ -0,0 +1,35 @@ +{ + "inference.put_azureaistudio": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-azure-ai-studio.html", + "description": "Configure an Azure AI Studio inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{azureaistudio_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "azureaistudio_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +} diff --git a/specification/_json_spec/inference.put_azureopenai.json b/specification/_json_spec/inference.put_azureopenai.json new file mode 100644 index 0000000000..8739adb1f5 --- /dev/null +++ b/specification/_json_spec/inference.put_azureopenai.json @@ -0,0 +1,35 @@ +{ + "inference.put_azureopenai": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-azure-openai.html", + "description": "Configure an Azure OpenAI inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{azureopenai_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "azureopenai_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +} diff --git a/specification/_json_spec/inference.put_cohere.json b/specification/_json_spec/inference.put_cohere.json new file mode 100644 index 0000000000..a00518f2c5 --- /dev/null +++ b/specification/_json_spec/inference.put_cohere.json @@ -0,0 +1,35 @@ +{ + "inference.put_cohere": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-cohere.html", + "description": "Configure a Cohere inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{cohere_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "cohere_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +} diff --git a/specification/_json_spec/inference.put_elasticsearch.json b/specification/_json_spec/inference.put_elasticsearch.json new file mode 100644 index 0000000000..0c326b79e9 --- /dev/null +++ b/specification/_json_spec/inference.put_elasticsearch.json @@ -0,0 +1,35 @@ +{ + "inference.put_elasticsearch": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elasticsearch.html", + "description": "Configure an Elasticsearch inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{elasticsearch_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "elasticsearch_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +} diff --git a/specification/_json_spec/inference.put_elser.json b/specification/_json_spec/inference.put_elser.json new file mode 100644 index 0000000000..b943b31a7d --- /dev/null +++ b/specification/_json_spec/inference.put_elser.json @@ -0,0 +1,39 @@ +{ + "inference.put_elser": { + "deprecated": { + "version": "8.16.0", + "description": "The elser service is deprecated. Use the Elasticsearch inference integration instead, with model_id included in the service_settings." + }, + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-elser.html", + "description": "Configure an ELSER inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{elser_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "elser_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +} diff --git a/specification/_json_spec/inference.put_googleaistudio.json b/specification/_json_spec/inference.put_googleaistudio.json new file mode 100644 index 0000000000..4574626b61 --- /dev/null +++ b/specification/_json_spec/inference.put_googleaistudio.json @@ -0,0 +1,35 @@ +{ + "inference.put_googleaistudio": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-google-ai-studio.html", + "description": "Configure a Google AI Studio inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{googleaistudio_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "googleaistudio_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +} diff --git a/specification/_json_spec/inference.put_googlevertexai.json b/specification/_json_spec/inference.put_googlevertexai.json new file mode 100644 index 0000000000..6068d4cbc9 --- /dev/null +++ b/specification/_json_spec/inference.put_googlevertexai.json @@ -0,0 +1,35 @@ +{ + "inference.put_googlevertexai": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-google-vertex-ai.html", + "description": "Configure a Google Vertex AI inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{googlevertexai_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "googlevertexai_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +} diff --git a/specification/_json_spec/inference.put_hugging_face.json b/specification/_json_spec/inference.put_hugging_face.json new file mode 100644 index 0000000000..76965d61ba --- /dev/null +++ b/specification/_json_spec/inference.put_hugging_face.json @@ -0,0 +1,35 @@ +{ + "inference.put_hugging_face": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-hugging-face.html", + "description": "Configure a HuggingFace inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{huggingface_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "huggingface_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +} diff --git a/specification/_json_spec/inference.put_jinaai.json b/specification/_json_spec/inference.put_jinaai.json new file mode 100644 index 0000000000..80af2a69c9 --- /dev/null +++ b/specification/_json_spec/inference.put_jinaai.json @@ -0,0 +1,35 @@ +{ + "inference.put_jinaai": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-jinaai.html", + "description": "Configure a JinaAI inference endpoint" + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_inference/{task_type}/{jinaai_inference_id}", + "methods": ["PUT"], + "parts": { + "task_type": { + "type": "string", + "description": "The task type" + }, + "jinaai_inference_id": { + "type": "string", + "description": "The inference Id" + } + } + } + ] + }, + "body": { + "description": "The inference endpoint's task and service settings" + } + } +}