查看知识库详情¶

按知识库 ID 查询模型定义和来源数量。更新或删除前应先用此接口确认当前状态。

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

调用前准备¶

先查询知识库列表取得知识库 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求参数¶

请求示例

curl "https://api.moi.matrixorigin.cn/v5/semantic-models/$MODEL_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

路径参数

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

成功响应¶

成功时返回 200。data 为知识库定义和来源数量。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 401,
    "name": "product_docs",
    "description": "产品文档",
    "tables": [],
    "files": [],
    "source_counts": {
      "files": 2,
      "tables": 1,
      "total": 3
    },
    "created_at": 1735632000,
    "updated_at": 1735718400
  }
}

字段说明

通用字段

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

知识库概览

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

字段	类型	说明
`id`	integer	知识库 ID。
`name`	string	知识库名称。
`description`	string	知识库说明；未设置时可能省略。
`tables`	array of object	兼容的旧式表来源定义。
`files`	object	兼容的旧式文件来源定义；未设置时可能省略。
`source_counts`	object	当前来源数量。
`created_at`	integer	Unix 时间戳。
`updated_at`	integer	Unix 时间戳。

数据表

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

字段	类型	说明
`db_name`	string	表来源所在的数据库名称。
`table_names`	array of string	该数据库中纳入知识库的表名称。

文件来源

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

字段	类型	说明
`file_ids`	array of string	文件 ID。
`parents`	array of string	文件来源的父路径。
`volume_ids`	array of string	文件来源的卷 ID。
`volumes`	array of object	文件来源卷及路径。
`vector_table`	string	向量表名称。
`embedding_model`	string	Embedding 模型标识。
`tags`	array of string	文件来源标签。

数据卷

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

字段	类型	说明
`volume_id`	string	卷 ID。
`parents`	array of string	卷来源的父路径。
`path`	array of string	卷内文件路径。

来源统计

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

字段	类型	说明
`files`	integer	文件来源数。
`tables`	integer	表来源数。
`total`	integer	来源总数。

错误响应¶

响应示例

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

字段说明

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

后续操作¶

需要修改属性时更新知识库；接入数据时添加数据源。

最后更新于 2026 年 9 月 28 日