Delete a legacy index template.
+Delete a legacy index template. + IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
`Get index templates. +
Get legacy index templates. Get information about one or more index templates.
IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
@@ -3850,8 +3851,34 @@ async def put_settings( Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.To revert a setting to the default value, use a null value.
- The list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.
+ The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.
To preserve existing settings from being updated, set the preserve_existing parameter to true.
There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:
+{
+ "number_of_replicas": 1
+ }
+ Or you can use an index setting object:
{
+ "index": {
+ "number_of_replicas": 1
+ }
+ }
+ Or you can use dot annotation:
+{
+ "index.number_of_replicas": 1
+ }
+ Or you can embed any of the aforementioned options in a settings object. For example:
{
+ "settings": {
+ "index": {
+ "number_of_replicas": 1
+ }
+ }
+ }
+ NOTE: You can only define new analyzers on closed indices. To add an analyzer, you must close the index, define the analyzer, and reopen the index. You cannot close the write index of a data stream. @@ -3971,7 +3998,7 @@ async def put_template( """ .. raw:: html -
Create or update an index template. +
Create or update a legacy index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name.
IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
diff --git a/elasticsearch/_async/client/inference.py b/elasticsearch/_async/client/inference.py index 7d90246e5..eef722b8e 100644 --- a/elasticsearch/_async/client/inference.py +++ b/elasticsearch/_async/client/inference.py @@ -370,12 +370,7 @@ async def put( """ .. raw:: html -Create an inference endpoint.
- When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an inference endpoint.
IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
@@ -458,11 +453,6 @@ async def put_alibabacloud(Create an AlibabaCloud AI Search inference endpoint.
Create an inference endpoint to perform an inference task with the alibabacloud-ai-search service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
info You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys.
-When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an Anthropic inference endpoint.
Create an inference endpoint to perform an inference task with the anthropic service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an Azure AI studio inference endpoint.
Create an inference endpoint to perform an inference task with the azureaistudio service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
The list of embeddings models that you can choose from in your deployment can be found in the Azure models documentation.
-When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create a Cohere inference endpoint.
Create an inference endpoint to perform an inference task with the cohere service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an Google AI Studio inference endpoint.
Create an inference endpoint to perform an inference task with the googleaistudio service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create a Google Vertex AI inference endpoint.
Create an inference endpoint to perform an inference task with the googlevertexai service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
multilingual-e5-basemultilingual-e5-smallWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an inference endpoint to perform an inference task with the jinaai service.
To review the available rerank models, refer to https://jina.ai/reranker.
To review the available text_embedding models, refer to the https://jina.ai/embeddings/.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create a Mistral inference endpoint.
Creates an inference endpoint to perform an inference task with the mistral service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an OpenAI inference endpoint.
Create an inference endpoint to perform an inference task with the openai service or openai compatible APIs.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an inference endpoint to perform an inference task with the watsonxai service.
You need an IBM Cloud Databases for Elasticsearch deployment to use the watsonxai inference service.
You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Delete a legacy index template.
+Delete a legacy index template. + IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
`Get index templates. +
Get legacy index templates. Get information about one or more index templates.
IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
@@ -3850,8 +3851,34 @@ def put_settings( Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.To revert a setting to the default value, use a null value.
- The list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.
+ The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.
To preserve existing settings from being updated, set the preserve_existing parameter to true.
There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:
+{
+ "number_of_replicas": 1
+ }
+ Or you can use an index setting object:
{
+ "index": {
+ "number_of_replicas": 1
+ }
+ }
+ Or you can use dot annotation:
+{
+ "index.number_of_replicas": 1
+ }
+ Or you can embed any of the aforementioned options in a settings object. For example:
{
+ "settings": {
+ "index": {
+ "number_of_replicas": 1
+ }
+ }
+ }
+ NOTE: You can only define new analyzers on closed indices. To add an analyzer, you must close the index, define the analyzer, and reopen the index. You cannot close the write index of a data stream. @@ -3971,7 +3998,7 @@ def put_template( """ .. raw:: html -
Create or update an index template. +
Create or update a legacy index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name.
IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
diff --git a/elasticsearch/_sync/client/inference.py b/elasticsearch/_sync/client/inference.py index e77ad84f0..318daab00 100644 --- a/elasticsearch/_sync/client/inference.py +++ b/elasticsearch/_sync/client/inference.py @@ -370,12 +370,7 @@ def put( """ .. raw:: html -Create an inference endpoint.
- When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an inference endpoint.
IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
@@ -458,11 +453,6 @@ def put_alibabacloud(Create an AlibabaCloud AI Search inference endpoint.
Create an inference endpoint to perform an inference task with the alibabacloud-ai-search service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
info You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys.
-When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an Anthropic inference endpoint.
Create an inference endpoint to perform an inference task with the anthropic service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an Azure AI studio inference endpoint.
Create an inference endpoint to perform an inference task with the azureaistudio service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
The list of embeddings models that you can choose from in your deployment can be found in the Azure models documentation.
-When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create a Cohere inference endpoint.
Create an inference endpoint to perform an inference task with the cohere service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an Google AI Studio inference endpoint.
Create an inference endpoint to perform an inference task with the googleaistudio service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create a Google Vertex AI inference endpoint.
Create an inference endpoint to perform an inference task with the googlevertexai service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
multilingual-e5-basemultilingual-e5-smallWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an inference endpoint to perform an inference task with the jinaai service.
To review the available rerank models, refer to https://jina.ai/reranker.
To review the available text_embedding models, refer to the https://jina.ai/embeddings/.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create a Mistral inference endpoint.
Creates an inference endpoint to perform an inference task with the mistral service.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an OpenAI inference endpoint.
Create an inference endpoint to perform an inference task with the openai service or openai compatible APIs.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
Create an inference endpoint to perform an inference task with the watsonxai service.
You need an IBM Cloud Databases for Elasticsearch deployment to use the watsonxai inference service.
You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.
When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
- After creating the endpoint, wait for the model deployment to complete before using it.
- To verify the deployment status, use the get trained model statistics API.
- Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count".
- Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.