更新推理 API

编辑

更新推理端点。

推理 API 使您能够使用某些服务,例如内置机器学习模型(ELSER、E5)、通过 Eland 上传的模型、Cohere、OpenAI、Azure、Google AI Studio、Google Vertex AI、Anthropic、Watsonx.ai 或 Hugging Face。对于内置模型和通过 Eland 上传的模型,推理 API 提供了一种使用和管理已训练模型的替代方法。但是,如果您不打算使用推理 API 来使用这些模型,或者您想使用非 NLP 模型,请使用 机器学习训练模型 API

请求

编辑

POST _inference/<inference_id>/_update

POST _inference/<task_type>/<inference_id>/_update

先决条件

编辑
  • 需要 manage_inference 集群权限(内置的 inference_admin 角色授予此权限)
  • 需要一个现有的推理端点,通过使用 创建推理 API 创建

描述

编辑

更新推理 API 使您能够更新现有推理端点的 task_settings、secrets 和/或 num_allocations。

要使用更新 API,您可以修改 task_settings、secrets(在 service_settings 中)或 num_allocations,具体取决于您创建的特定端点服务和 task_type。要查看可更新的 task_settings、secrets 的字段名称(特定于每个服务)以及 num_allocations 适用的服务(仅适用于 elasticsearch 服务),请参阅以下推理 API 可用服务的列表。您将在每个服务名称旁边找到可用的任务类型。点击链接查看服务配置详细信息

路径参数

编辑
<inference_id>
(必填,字符串) 推理端点的唯一标识符。
<task_type>
(可选,字符串) 模型执行的推理任务类型。有关可用的任务类型,请参阅 API 描述部分 中的服务列表。

示例

编辑

以下示例显示了如何更新名为 my-inference-endpoint 的推理端点的 API 密钥

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