Update inference API

Updates an inference endpoint.

PUT _inference/<inference_id>/_update

PUT _inference/<task_type>/<inference_id>/_update

The update inference API enables you to update the task_settings, secrets, and/or num_allocations of an existing inference endpoint.

To use the update API, you can modify task_settings, secrets (within service_settings), or num_allocations, depending on the specific endpoint service and task_type you’ve created. To view the updatable task_settings, the field names of secrets (specific to each service), and the services where num_allocations is applicable (only for the elasticsearch service), refer to the following list of services available through the inference API. You will find the available task types next to each service name. Click the links to review the service configuration details:

The following example shows how to update an API key of an inference endpoint called my-inference-endpoint:

resp = client.inference.update(
    inference_id="my-inference-endpoint",
    inference_config={
        "service_settings": {
            "api_key": "<API_KEY>"
        }
    },
)
print(resp)

const response = await client.inference.put({
  task_type: "my-inference-endpoint",
  inference_id: "_update",
  inference_config: {
    service_settings: {
      api_key: "<API_KEY>",
    },
  },
});
console.log(response);

PUT _inference/my-inference-endpoint/_update
{
 "service_settings": {
   "api_key": "<API_KEY>"
 }
}