工作区式嵌入模型更新后端

修改指定嵌入模型后端的名称、模型声明及支持的配置字段。

PUT https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/embeddings/backends/{backend_id}

调用前准备

BASE_URL 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。

配置同环境身份、工作区与对象权限。

请求

curl --request PUT \
  "$BASE_URL/workspaces/$WORKSPACE_ID/embeddings/backends/$BACKEND_ID" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID" \
  --header "Content-Type: application/json" \
  --data-raw '{"name":"更新后"}'

参数

位置

类型

必填

说明

X-Workspace-ID

请求头

string

是

同环境工作区 ID。

workspace_id

路径

string

是

同环境工作区 ID。

backend_id

路径

integer

是

由前序读取返回的正数 ID。

name

请求体

string

否

省略/null/空或全空白保留旧名称。

api_key_encrypted

请求体

string

否

非空替换,省略/null/空保留;不能用空值清除凭据。

timeout_seconds

请求体

integer

否

正数时更新;省略/null/非正保留。

models

请求体

array(字符串数组)或 null

否

省略/null 保留;[] 清空;非空数组替换全部。

reasoning_control_protocol

请求体

integer 或 null

否

仅 LLM:省略/null 保留;0 显式重设 NONE,其他合法值 1~5。

provider_origin

请求体

string 或 null

否

仅 LLM:省略/null 保留,显式仅 external_provider,空串拒绝。

origin_ref

请求体

string 或 null

否

仅 LLM:省略/null 保留,空串清除。

origin_version

请求体

string 或 null

否

仅 LLM:省略/null 保留,空串清除。

需要对象 model_backend.update。类型不在更新结构中;不支持业务 request_id/CAS 保护,写后回读所需字段。当前专用 Go/Python/CLI 会省略 models=[],清空操作应使用能保留完整 HTTP 数组的调用;回包不包含空 models 字段也可能表示空集合。

成功响应

{
  "code": 0,
  "data": {
    "id": 12,
    "name": "更新后",
    "timeout_seconds": 30,
    "models": [
      "bge-m3"
    ],
    "created_at": 1794445200,
    "updated_at": 1794445200,
    "provider_origin": "unknown",
    "api_key_encrypted": "provider-key-example"
  }
}

HTTP 200。

字段

类型

说明

code

integer

成功0。

data

object

当前协议的实际对象。

错误响应

错误与结果确认按两套协议区分。省略字段、SDK 零值和 HTTP 空响应分别解析,写后使用对应读取动作确认。

最后更新于