更新连接器
2.12 版本引入
使用此 API 可基于 model_ID
更新独立连接器。要更新在特定模型中创建的连接器,请使用更新模型 API。
在更新独立连接器之前,必须取消部署所有使用该连接器的模型。有关取消部署模型的信息,请参阅取消部署模型 API。
使用此 API,您可以更新请求字段部分中列出的连接器字段,并向连接器添加可选字段。您不能使用此 API 从连接器中删除字段。
有关此 API 的用户访问信息,请参阅模型访问控制注意事项。
端点
PUT /_plugins/_ml/connectors/<connector_id>
请求正文字段
下表列出了可更新的字段。有关所有连接器字段的更多信息,请参阅蓝图配置参数。
字段 | 数据类型 | 描述 |
---|---|---|
名称 | 字符串 | 连接器名称。 |
description | 字符串 | 连接器的描述。 |
version | 整数 | 连接器版本。 |
protocol | 字符串 | 连接协议。对于 AWS 服务,例如 Amazon SageMaker 和 Amazon Bedrock,请使用 aws_sigv4 。对于所有其他服务,请使用 http 。 |
parameters | JSON 对象 | 默认连接器参数,包括 endpoint 和 model 。此字段中包含的任何参数都可以被预测请求中指定的参数覆盖。 |
credential | JSON 对象 | 定义连接到所选端点所需的任何凭据变量。ML Commons 使用 **AES/GCM/NoPadding** 对称加密来加密您的凭据。当首次启动与集群的连接时,OpenSearch 会创建一个随机的 32 字节加密密钥,该密钥会持久存储在 OpenSearch 的系统索引中。因此,您无需手动设置加密密钥。 |
actions | JSON 数组 | 定义可在连接器中运行的操作。如果您是创建连接的管理员,请添加所需连接的蓝图。 |
backend_roles | JSON 数组 | OpenSearch 后端角色列表。有关设置后端角色的更多信息,请参阅将后端角色分配给用户。 |
access_mode | 字符串 | 设置模型的访问模式,可以是 public 、restricted 或 private 。默认值为 private 。有关 access_mode 的更多信息,请参阅模型组。 |
parameters.skip_validating_missing_parameters | 布尔型 | 当设置为 true 时,此选项允许您使用连接器发送请求,而无需验证任何缺失参数。默认值为 false 。 |
请求示例
PUT /_plugins/_ml/connectors/u3DEbI0BfUsSoeNTti-1
{
"description": "The connector to public OpenAI model service for GPT 3.5"
}
示例响应
{
"_index": ".plugins-ml-connector",
"_id": "u3DEbI0BfUsSoeNTti-1",
"_version": 2,
"result": "updated",
"_shards": {
"total": 1,
"successful": 1,
"failed": 0
},
"_seq_no": 2,
"_primary_term": 1
}