更新知识库¶

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

PUT https://api.moi.matrixorigin.cn/v5/semantic-models/{model_id}

调用前准备¶

先查询知识库详情，确认当前定义。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求体¶

请求示例

curl -X PUT "https://api.moi.matrixorigin.cn/v5/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"
  }'

参数说明

路径参数

字段	类型	必填	说明
`model_id`	integer	是	知识库 ID。

请求体

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

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

数据表

下面表格展开请求示例中 tables 数组的每一项；每一行是该数组项的一个字段。

字段	类型	必填	说明
`db_name`	string	是	数据库名称。
`table_names`	array of string	是	该数据库中的表名称。

文件来源

下面表格展开请求示例中 files 对象；每一行是该对象的一个字段。

字段	类型	必填	说明
`file_ids`	array of string	否	文件 ID。
`parents`	array of string	否	文件父目录路径。
`volume_ids`	array of integer	否	卷 ID。
`volumes`	array of object	否	卷及其扫描路径。
`vector_table`	string	否	文本向量表名称。
`embedding_model`	string	否	文本嵌入模型标识。
`image_vector_table`	string	否	图片向量表名称。
`image_embedding_model`	string	否	图片嵌入模型标识。
`image_embedding_backend_id`	string	否	图片嵌入后端 ID。
`image_embedding_dimension`	integer	否	图片嵌入维度。
`image_preprocess_version`	string	否	图片预处理版本。
`image_distance_metric`	string	否	图片向量距离度量。
`tags`	array of string	否	文件来源标签。

数据卷

下面表格展开请求示例中 files.volumes 数组的每一项；每一行是该数组项的一个字段。

字段	类型	必填	说明
`volume_id`	integer	是	卷 ID。
`parents`	array of string	否	卷内父目录路径。
`path`	string	否	卷内起始路径。

成功响应¶

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

响应示例

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

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。

知识库概览

下面表格展开响应示例中 data 对象；每一行是该对象的一个字段。

字段	类型	说明
`updated`	boolean	`true` 表示更新请求已被服务端接受并完成。

错误响应¶

响应示例

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

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	面向调用者的错误信息。
`data`	null	发生错误时为 `null`。

后续操作¶

查询知识库详情确认更新结果。

最后更新于 2026 年 9 月 28 日