查询知识库列表¶
分页列出当前工作区可读取的知识库(语义模型)。先通过此接口找到知识库 ID,再查询详情或添加数据源。
GET https://moi.matrixorigin.cn/newmoi/semantic-models
调用前准备¶
准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:要查询的工作区 ID,通过X-Workspace-IDHeader 传递。
查询参数¶
接口支持服务端分页;继续使用响应返回的 next_page_token,不要根据当前页条目数推断末页。
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
否 |
单页条数,范围为 |
|
string |
否 |
上一页响应中的 |
|
string |
否 |
名称或说明的搜索条件。 |
|
string(字符串数组) |
否 |
标签筛选条件。重复传入参数,例如 |
请求示例¶
curl "https://moi.matrixorigin.cn/newmoi/semantic-models?page_size=20&search=product&tags=product" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
成功响应¶
成功时返回 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": ""
}
}
响应字段如下。
字段路径中的 [] 表示数组中的每一项。例如,data.items[].id 表示 data.items 数组中每一项的 id 字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
object(对象数组) |
当前页的知识库。 |
|
integer |
知识库 ID,可作为后续接口的 |
|
string |
知识库名称。 |
|
string |
知识库说明;未设置时可能省略。 |
|
JSON |
兼容的旧式表来源定义。 |
|
JSON |
兼容的旧式文件来源定义;未设置时可能省略。 |
|
object |
列表或详情路径补充的来源数量。 |
|
integer |
文件来源数。 |
|
integer |
表来源数。 |
|
integer |
来源总数。 |
|
integer |
创建时间的 Unix 时间戳。 |
|
integer |
更新时间的 Unix 时间戳。 |
|
integer |
匹配当前筛选条件的总数。 |
|
string |
读取下一页时原样传入的令牌。 |
读取下一页¶
data.next_page_token 非空时,将其作为 page_token 传入下一次请求,直到返回空令牌。
错误响应¶
请求失败时返回相同的包络,其中 data 为 null。
{
"code": "ErrParamInvalid",
"msg": "page_size is invalid",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
|
修正页大小后重试。 |
|
|
API Key 无效或已失效。 |
检查 API Key。 |
|
|
调用者没有读取知识库集合的权限。 |
检查工作区和对象授权。 |
|
|
服务未能完成列表查询。 |
保留脱敏后的响应信息后重试。 |
后续操作¶
使用 data.items[].id 查询知识库详情。