# 更新知识库

更新知识库描述或兼容的旧式来源字段。知识库名称创建后不可修改；更新时必须回传当前名称。新接入来源请使用单独的数据源接口。

```text
PUT https://moi.matrixorigin.cn/newmoi/semantic-models/{model_id}
```

## 调用前准备

先[查询知识库详情](get-knowledge-base.md)，确认当前定义。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递。
- `$MODEL_ID`：要更新的知识库 ID。

## 路径参数

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `model_id` | integer | 知识库 ID。 |

## 请求体

提交当前的完整 `name`，可同时提交 `description` 以及接口兼容的 `tables`、`files` 来源定义。

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `name` | string | 是 | 当前知识库名称。该值不可变，必须与已创建的名称一致。 |
| `description` | string | 否 | 更新后的知识库说明。 |
| `tables` | JSON | 否 | 兼容的旧式表来源定义。 |
| `files` | JSON | 否 | 兼容的旧式文件来源定义。 |

## 请求示例

```bash
curl -X PUT "https://moi.matrixorigin.cn/newmoi/semantic-models/$MODEL_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "$CURRENT_KNOWLEDGE_BASE_NAME",
    "description": "$DESCRIPTION"
  }'
```

## 成功响应

成功时返回 `200`。接口返回确认标记；如需读取更新后的完整对象，请再调用查询知识库详情接口。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "updated": true
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.updated` | boolean | `true` 表示更新请求已被服务端接受并完成。 |

## 错误响应

```json
{
  "code": "ErrNotFound",
  "msg": "resource not found",
  "data": null
}
```

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - `model_id`、JSON 请求体或必填名称无效，或 `name` 与当前名称不同。
  - 使用有效 ID，回传当前名称并提交完整且有效的更新定义。
* - `401`
  - `ErrUnauthorized`
  - API Key 无效或已失效。
  - 检查 API Key。
* - `403`
  - `ErrForbidden`
  - 调用者没有更新该知识库的权限。
  - 检查工作区和对象授权。
* - `404`
  - `ErrNotFound`
  - 知识库不存在或当前调用者不可见。
  - 重新列出知识库并确认 ID。
* - `500`
  - `ErrServer`
  - 服务未能完成更新。
  - 保留脱敏后的响应信息后重试。
```

## 后续操作

[查询知识库详情](get-knowledge-base.md)确认更新结果。