查看知识库列表¶

分页列出当前工作区可读取的知识库（语义模型）。先通过此接口找到知识库 ID，再查询详情或添加数据源。

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

调用前准备¶

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求参数¶

请求示例

curl "https://api.moi.matrixorigin.cn/v5/semantic-models?page_size=20&search=product&tags=product" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

查询参数

接口支持服务端分页；继续使用响应返回的 next_page_token，不要根据当前页条目数推断末页。

字段	类型	必填	说明
`page_size`	integer	否	单页条数，范围为 `1` 至 `100`；不传时为 `20`。
`page_token`	string	否	上一页响应中的 `next_page_token`。
`search`	string	否	名称或说明的搜索条件。
`tags`	array of string	否	标签筛选条件。重复传入参数，例如 `tags=product&tags=support`。

成功响应¶

成功时返回 200。从 data.items 中取得当前页的知识库；data.next_page_token 为空或未返回时，表示没有下一页。

响应示例

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

字段说明

通用字段

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

查询结果

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

字段	类型	说明
`items`	array of object	当前页的知识库。
`total`	integer	匹配当前筛选条件的总数。
`next_page_token`	string	读取下一页时原样传入的令牌。

知识库

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

字段	类型	说明
`id`	integer	知识库 ID，可作为后续接口的 `model_id`。
`name`	string	知识库名称。
`description`	string	知识库说明；未设置时可能省略。
`tables`	array of object	兼容的旧式表来源定义。
`files`	object	兼容的旧式文件来源定义；未设置时可能省略。
`source_counts`	object	列表或详情路径补充的来源数量。
`created_at`	integer	创建时间的 Unix 时间戳。
`updated_at`	integer	更新时间的 Unix 时间戳。

数据表

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

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

文件来源

下面表格展开响应示例中 data.items[].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.items[].files.volumes 数组的每一项；每一行是该数组项的一个字段。

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

来源统计

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

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

读取下一页

data.next_page_token 非空时，将其作为 page_token 传入下一次请求，直到返回空令牌。

错误响应¶

请求失败时返回相同的包络，其中 data 为 null。

响应示例

{
  "code": "ErrParamInvalid",
  "msg": "page_size is invalid",
  "data": null
}

字段说明

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

后续操作¶

使用 data.items[].id 查询知识库详情。

最后更新于 2026 年 9 月 9 日